@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSRedshiftDataAPIAsyncClient extends AWSRedshiftDataAPIClient implements AWSRedshiftDataAPIAsync
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 individual SQL statements, which are committed if the statement succeeds.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIXbuilder, cancelStatement, describeStatement, describeTable, executeStatement, getCachedResponseMetadata, getStatementResult, listDatabases, listSchemas, listStatements, listTablesaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcancelStatement, describeStatement, describeTable, executeStatement, getCachedResponseMetadata, getStatementResult, listDatabases, listSchemas, listStatements, listTablespublic static AWSRedshiftDataAPIAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest request)
AWSRedshiftDataAPIAsyncCancels a running query. To be canceled, a query must be running.
cancelStatementAsync in interface AWSRedshiftDataAPIAsyncpublic Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest request, AsyncHandler<CancelStatementRequest,CancelStatementResult> asyncHandler)
AWSRedshiftDataAPIAsyncCancels a running query. To be canceled, a query must be running.
cancelStatementAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest request)
AWSRedshiftDataAPIAsyncDescribes 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.
describeStatementAsync in interface AWSRedshiftDataAPIAsyncpublic Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest request, AsyncHandler<DescribeStatementRequest,DescribeStatementResult> asyncHandler)
AWSRedshiftDataAPIAsyncDescribes 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.
describeStatementAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public Future<DescribeTableResult> describeTableAsync(DescribeTableRequest request)
AWSRedshiftDataAPIAsyncDescribes 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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
describeTableAsync in interface AWSRedshiftDataAPIAsyncpublic Future<DescribeTableResult> describeTableAsync(DescribeTableRequest request, AsyncHandler<DescribeTableRequest,DescribeTableResult> asyncHandler)
AWSRedshiftDataAPIAsyncDescribes 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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
describeTableAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest request)
AWSRedshiftDataAPIAsyncRuns 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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
executeStatementAsync in interface AWSRedshiftDataAPIAsyncpublic Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest request, AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler)
AWSRedshiftDataAPIAsyncRuns 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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
executeStatementAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest request)
AWSRedshiftDataAPIAsyncFetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.
getStatementResultAsync in interface AWSRedshiftDataAPIAsyncpublic Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest request, AsyncHandler<GetStatementResultRequest,GetStatementResultResult> asyncHandler)
AWSRedshiftDataAPIAsyncFetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.
getStatementResultAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest request)
AWSRedshiftDataAPIAsyncList 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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
listDatabasesAsync in interface AWSRedshiftDataAPIAsyncpublic Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest request, AsyncHandler<ListDatabasesRequest,ListDatabasesResult> asyncHandler)
AWSRedshiftDataAPIAsyncList 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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
listDatabasesAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request)
AWSRedshiftDataAPIAsyncLists 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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
listSchemasAsync in interface AWSRedshiftDataAPIAsyncpublic Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request, AsyncHandler<ListSchemasRequest,ListSchemasResult> asyncHandler)
AWSRedshiftDataAPIAsyncLists 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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
listSchemasAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest request)
AWSRedshiftDataAPIAsyncList of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.
listStatementsAsync in interface AWSRedshiftDataAPIAsyncpublic Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest request, AsyncHandler<ListStatementsRequest,ListStatementsResult> asyncHandler)
AWSRedshiftDataAPIAsyncList of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.
listStatementsAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public Future<ListTablesResult> listTablesAsync(ListTablesRequest request)
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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
listTablesAsync in interface AWSRedshiftDataAPIAsyncpublic Future<ListTablesResult> listTablesAsync(ListTablesRequest request, AsyncHandler<ListTablesRequest,ListTablesResult> asyncHandler)
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:
AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret 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.
listTablesAsync in interface AWSRedshiftDataAPIAsyncasyncHandler - 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.public void shutdown()
getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to
calling this method.shutdown in interface AWSRedshiftDataAPIshutdown in class AWSRedshiftDataAPIClient