com.amazonaws.services.redshiftdataapi

Interface AWSRedshiftDataAPIAsync

All Superinterfaces:

AWSRedshiftDataAPI

All Known Implementing Classes:

AbstractAWSRedshiftDataAPIAsync, AWSRedshiftDataAPIAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSRedshiftDataAPIAsync
extends AWSRedshiftDataAPI

Interface for accessing Redshift Data API Service 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 AbstractAWSRedshiftDataAPIAsync instead.

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds.

For more information about the Amazon Redshift Data API, see Using the Amazon Redshift Data API in the Amazon Redshift Cluster Management Guide.

Field Summary

Fields inherited from interface com.amazonaws.services.redshiftdataapi.AWSRedshiftDataAPI

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<BatchExecuteStatementResult>	batchExecuteStatementAsync(BatchExecuteStatementRequest batchExecuteStatementRequest) Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL).
Future<BatchExecuteStatementResult>	batchExecuteStatementAsync(BatchExecuteStatementRequest batchExecuteStatementRequest, AsyncHandler<BatchExecuteStatementRequest,BatchExecuteStatementResult> asyncHandler) Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL).
Future<CancelStatementResult>	cancelStatementAsync(CancelStatementRequest cancelStatementRequest) Cancels a running query.
Future<CancelStatementResult>	cancelStatementAsync(CancelStatementRequest cancelStatementRequest, AsyncHandler<CancelStatementRequest,CancelStatementResult> asyncHandler) Cancels a running query.
Future<DescribeStatementResult>	describeStatementAsync(DescribeStatementRequest describeStatementRequest) Describes the details about a specific instance when a query was run by the Amazon Redshift Data API.
Future<DescribeStatementResult>	describeStatementAsync(DescribeStatementRequest describeStatementRequest, AsyncHandler<DescribeStatementRequest,DescribeStatementResult> asyncHandler) Describes the details about a specific instance when a query was run by the Amazon Redshift Data API.
Future<DescribeTableResult>	describeTableAsync(DescribeTableRequest describeTableRequest) Describes the detailed information about a table from metadata in the cluster.
Future<DescribeTableResult>	describeTableAsync(DescribeTableRequest describeTableRequest, AsyncHandler<DescribeTableRequest,DescribeTableResult> asyncHandler) Describes the detailed information about a table from metadata in the cluster.
Future<ExecuteStatementResult>	executeStatementAsync(ExecuteStatementRequest executeStatementRequest) Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL).
Future<ExecuteStatementResult>	executeStatementAsync(ExecuteStatementRequest executeStatementRequest, AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler) Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL).
Future<GetStatementResultResult>	getStatementResultAsync(GetStatementResultRequest getStatementResultRequest) Fetches the temporarily cached result of an SQL statement.
Future<GetStatementResultResult>	getStatementResultAsync(GetStatementResultRequest getStatementResultRequest, AsyncHandler<GetStatementResultRequest,GetStatementResultResult> asyncHandler) Fetches the temporarily cached result of an SQL statement.
Future<ListDatabasesResult>	listDatabasesAsync(ListDatabasesRequest listDatabasesRequest) List the databases in a cluster.
Future<ListDatabasesResult>	listDatabasesAsync(ListDatabasesRequest listDatabasesRequest, AsyncHandler<ListDatabasesRequest,ListDatabasesResult> asyncHandler) List the databases in a cluster.
Future<ListSchemasResult>	listSchemasAsync(ListSchemasRequest listSchemasRequest) Lists the schemas in a database.
Future<ListSchemasResult>	listSchemasAsync(ListSchemasRequest listSchemasRequest, AsyncHandler<ListSchemasRequest,ListSchemasResult> asyncHandler) Lists the schemas in a database.
Future<ListStatementsResult>	listStatementsAsync(ListStatementsRequest listStatementsRequest) List of SQL statements.
Future<ListStatementsResult>	listStatementsAsync(ListStatementsRequest listStatementsRequest, AsyncHandler<ListStatementsRequest,ListStatementsResult> asyncHandler) List of SQL statements.
Future<ListTablesResult>	listTablesAsync(ListTablesRequest listTablesRequest) List the tables in a database.
Future<ListTablesResult>	listTablesAsync(ListTablesRequest listTablesRequest, AsyncHandler<ListTablesRequest,ListTablesResult> asyncHandler) List the tables in a database.

Methods inherited from interface com.amazonaws.services.redshiftdataapi.AWSRedshiftDataAPI

batchExecuteStatement, cancelStatement, describeStatement, describeTable, executeStatement, getCachedResponseMetadata, getStatementResult, listDatabases, listSchemas, listStatements, listTables, shutdown

Method Detail

batchExecuteStatementAsync

Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest batchExecuteStatementRequest)

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

batchExecuteStatementRequest -

Returns:

A Java Future containing the result of the BatchExecuteStatement operation returned by the service.

See Also:

AWS API Documentation

batchExecuteStatementAsync

Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest batchExecuteStatementRequest,
                                                               AsyncHandler<BatchExecuteStatementRequest,BatchExecuteStatementResult> asyncHandler)

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

batchExecuteStatementRequest -

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 BatchExecuteStatement operation returned by the service.

See Also:

AWS API Documentation

cancelStatementAsync

Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest cancelStatementRequest)

Cancels a running query. To be canceled, a query must be running.

Parameters:

cancelStatementRequest -

Returns:

A Java Future containing the result of the CancelStatement operation returned by the service.

See Also:

AWS API Documentation

cancelStatementAsync

Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest cancelStatementRequest,
                                                   AsyncHandler<CancelStatementRequest,CancelStatementResult> asyncHandler)

Cancels a running query. To be canceled, a query must be running.

Parameters:

cancelStatementRequest -

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 CancelStatement operation returned by the service.

See Also:

AWS API Documentation

describeStatementAsync

Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest describeStatementRequest)

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.

Parameters:

describeStatementRequest -

Returns:

A Java Future containing the result of the DescribeStatement operation returned by the service.

See Also:

AWS API Documentation

describeStatementAsync

Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest describeStatementRequest,
                                                       AsyncHandler<DescribeStatementRequest,DescribeStatementResult> asyncHandler)

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.

Parameters:

describeStatementRequest -

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 DescribeStatement operation returned by the service.

See Also:

AWS API Documentation

describeTableAsync

Future<DescribeTableResult> describeTableAsync(DescribeTableRequest describeTableRequest)

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

describeTableRequest -

Returns:

A Java Future containing the result of the DescribeTable operation returned by the service.

See Also:

AWS API Documentation

describeTableAsync

Future<DescribeTableResult> describeTableAsync(DescribeTableRequest describeTableRequest,
                                               AsyncHandler<DescribeTableRequest,DescribeTableResult> asyncHandler)

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

describeTableRequest -

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 DescribeTable operation returned by the service.

See Also:

AWS API Documentation

executeStatementAsync

Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest executeStatementRequest)

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

executeStatementRequest -

Returns:

A Java Future containing the result of the ExecuteStatement operation returned by the service.

See Also:

AWS API Documentation

executeStatementAsync

Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest executeStatementRequest,
                                                     AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler)

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

executeStatementRequest -

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 ExecuteStatement operation returned by the service.

See Also:

AWS API Documentation

getStatementResultAsync

Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest getStatementResultRequest)

Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.

Parameters:

getStatementResultRequest -

Returns:

A Java Future containing the result of the GetStatementResult operation returned by the service.

See Also:

AWS API Documentation

getStatementResultAsync

Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest getStatementResultRequest,
                                                         AsyncHandler<GetStatementResultRequest,GetStatementResultResult> asyncHandler)

Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.

Parameters:

getStatementResultRequest -

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 GetStatementResult operation returned by the service.

See Also:

AWS API Documentation

listDatabasesAsync

Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest listDatabasesRequest)

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

listDatabasesRequest -

Returns:

A Java Future containing the result of the ListDatabases operation returned by the service.

See Also:

AWS API Documentation

listDatabasesAsync

Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest listDatabasesRequest,
                                               AsyncHandler<ListDatabasesRequest,ListDatabasesResult> asyncHandler)

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

listDatabasesRequest -

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 ListDatabases operation returned by the service.

See Also:

AWS API Documentation

listSchemasAsync

Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest listSchemasRequest)

Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

listSchemasRequest -

Returns:

A Java Future containing the result of the ListSchemas operation returned by the service.

See Also:

AWS API Documentation

listSchemasAsync

Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest listSchemasRequest,
                                           AsyncHandler<ListSchemasRequest,ListSchemasResult> asyncHandler)

Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

Parameters:

listSchemasRequest -

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 ListSchemas operation returned by the service.

See Also:

AWS API Documentation

listStatementsAsync

Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest listStatementsRequest)

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

Parameters:

listStatementsRequest -

Returns:

A Java Future containing the result of the ListStatements operation returned by the service.

See Also:

AWS API Documentation

listStatementsAsync

Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest listStatementsRequest,
                                                 AsyncHandler<ListStatementsRequest,ListStatementsResult> asyncHandler)

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

Parameters:

listStatementsRequest -

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 ListStatements operation returned by the service.

See Also:

AWS API Documentation

listTablesAsync

Future<ListTablesResult> listTablesAsync(ListTablesRequest listTablesRequest)

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

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)

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

• Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret.

• Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the redshift:GetClusterCredentials operation is required to use this method.

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