com.amazonaws.services.redshiftdataapi

Class AWSRedshiftDataAPIAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.redshiftdataapi.AWSRedshiftDataAPIClient

com.amazonaws.services.redshiftdataapi.AWSRedshiftDataAPIAsyncClient

All Implemented Interfaces:

AWSRedshiftDataAPI, AWSRedshiftDataAPIAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSRedshiftDataAPIAsyncClient
extends AWSRedshiftDataAPIClient
implements AWSRedshiftDataAPIAsync

Client 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.

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 and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSRedshiftDataAPIAsyncClientBuilder	asyncBuilder()
Future<BatchExecuteStatementResult>	batchExecuteStatementAsync(BatchExecuteStatementRequest request) Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL).
Future<BatchExecuteStatementResult>	batchExecuteStatementAsync(BatchExecuteStatementRequest request, 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 request) Cancels a running query.
Future<CancelStatementResult>	cancelStatementAsync(CancelStatementRequest request, AsyncHandler<CancelStatementRequest,CancelStatementResult> asyncHandler) Cancels a running query.
Future<DescribeStatementResult>	describeStatementAsync(DescribeStatementRequest request) Describes the details about a specific instance when a query was run by the Amazon Redshift Data API.
Future<DescribeStatementResult>	describeStatementAsync(DescribeStatementRequest request, 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 request) Describes the detailed information about a table from metadata in the cluster.
Future<DescribeTableResult>	describeTableAsync(DescribeTableRequest request, AsyncHandler<DescribeTableRequest,DescribeTableResult> asyncHandler) Describes the detailed information about a table from metadata in the cluster.
Future<ExecuteStatementResult>	executeStatementAsync(ExecuteStatementRequest request) Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL).
Future<ExecuteStatementResult>	executeStatementAsync(ExecuteStatementRequest request, AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler) Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL).
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetStatementResultResult>	getStatementResultAsync(GetStatementResultRequest request) Fetches the temporarily cached result of an SQL statement.
Future<GetStatementResultResult>	getStatementResultAsync(GetStatementResultRequest request, AsyncHandler<GetStatementResultRequest,GetStatementResultResult> asyncHandler) Fetches the temporarily cached result of an SQL statement.
Future<ListDatabasesResult>	listDatabasesAsync(ListDatabasesRequest request) List the databases in a cluster.
Future<ListDatabasesResult>	listDatabasesAsync(ListDatabasesRequest request, AsyncHandler<ListDatabasesRequest,ListDatabasesResult> asyncHandler) List the databases in a cluster.
Future<ListSchemasResult>	listSchemasAsync(ListSchemasRequest request) Lists the schemas in a database.
Future<ListSchemasResult>	listSchemasAsync(ListSchemasRequest request, AsyncHandler<ListSchemasRequest,ListSchemasResult> asyncHandler) Lists the schemas in a database.
Future<ListStatementsResult>	listStatementsAsync(ListStatementsRequest request) List of SQL statements.
Future<ListStatementsResult>	listStatementsAsync(ListStatementsRequest request, AsyncHandler<ListStatementsRequest,ListStatementsResult> asyncHandler) List of SQL statements.
Future<ListTablesResult>	listTablesAsync(ListTablesRequest request) List the tables in a database.
Future<ListTablesResult>	listTablesAsync(ListTablesRequest request, AsyncHandler<ListTablesRequest,ListTablesResult> asyncHandler) List the tables in a database.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.redshiftdataapi.AWSRedshiftDataAPIClient

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

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Method Detail

asyncBuilder

public static AWSRedshiftDataAPIAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

batchExecuteStatementAsync

public Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

batchExecuteStatementAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

batchExecuteStatementAsync

public Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest request,
                                                                      AsyncHandler<BatchExecuteStatementRequest,BatchExecuteStatementResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

batchExecuteStatementAsync in interface AWSRedshiftDataAPIAsync

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

public Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

cancelStatementAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

cancelStatementAsync

public Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest request,
                                                          AsyncHandler<CancelStatementRequest,CancelStatementResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

cancelStatementAsync in interface AWSRedshiftDataAPIAsync

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

public Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

describeStatementAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

describeStatementAsync

public Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest request,
                                                              AsyncHandler<DescribeStatementRequest,DescribeStatementResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

describeStatementAsync in interface AWSRedshiftDataAPIAsync

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

public Future<DescribeTableResult> describeTableAsync(DescribeTableRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

describeTableAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

describeTableAsync

public Future<DescribeTableResult> describeTableAsync(DescribeTableRequest request,
                                                      AsyncHandler<DescribeTableRequest,DescribeTableResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

describeTableAsync in interface AWSRedshiftDataAPIAsync

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

public Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

executeStatementAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

executeStatementAsync

public Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest request,
                                                            AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

executeStatementAsync in interface AWSRedshiftDataAPIAsync

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

public Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

getStatementResultAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

getStatementResultAsync

public Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest request,
                                                                AsyncHandler<GetStatementResultRequest,GetStatementResultResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

getStatementResultAsync in interface AWSRedshiftDataAPIAsync

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

public Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

listDatabasesAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

listDatabasesAsync

public Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest request,
                                                      AsyncHandler<ListDatabasesRequest,ListDatabasesResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

listDatabasesAsync in interface AWSRedshiftDataAPIAsync

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

public Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

listSchemasAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

listSchemasAsync

public Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request,
                                                  AsyncHandler<ListSchemasRequest,ListSchemasResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

listSchemasAsync in interface AWSRedshiftDataAPIAsync

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

public Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

listStatementsAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

listStatementsAsync

public Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest request,
                                                        AsyncHandler<ListStatementsRequest,ListStatementsResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

listStatementsAsync in interface AWSRedshiftDataAPIAsync

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

public Future<ListTablesResult> listTablesAsync(ListTablesRequest request)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

listTablesAsync in interface AWSRedshiftDataAPIAsync

Returns:

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

See Also:

AWS API Documentation

listTablesAsync

public Future<ListTablesResult> listTablesAsync(ListTablesRequest request,
                                                AsyncHandler<ListTablesRequest,ListTablesResult> asyncHandler)

Description copied from interface: AWSRedshiftDataAPIAsync

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 - when connecting to a cluster, provide the secret-arn of a secret stored in Secrets Manager which has username and password. The specified secret contains credentials to connect to the database you specify. When you are connecting to a cluster, you also supply the database name, If you provide a cluster identifier (dbClusterIdentifier), it must match the cluster identifier stored in the secret. When you are connecting to a serverless workgroup, you also supply the database name.

• Temporary credentials - when connecting to your data warehouse, choose one of the following options:

  • When connecting to a serverless workgroup, specify the workgroup name and database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift-serverless:GetCredentials operation is required.

  • When connecting to a cluster as an IAM identity, specify the cluster identifier and the database name. The database user name is derived from the IAM identity. For example, arn:iam::123456789012:user:foo has the database user name IAM:foo. Also, permission to call the redshift:GetClusterCredentialsWithIAM operation is required.

  • When connecting to a cluster as a database user, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required.

For more information about the Amazon Redshift Data API and CLI usage examples, see Using the Amazon Redshift Data API in the Amazon Redshift Management Guide.

Specified by:

listTablesAsync in interface AWSRedshiftDataAPIAsync

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

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSRedshiftDataAPI

Overrides:

shutdown in class AWSRedshiftDataAPIClient