/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.redshiftdataapi; import javax.annotation.Generated; import com.amazonaws.services.redshiftdataapi.model.*; /** * 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 {@code 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 * {@link com.amazonaws.services.redshiftdataapi.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 and CLI usage examples, see Using the Amazon Redshift Data API in the * Amazon Redshift Management Guide. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSRedshiftDataAPIAsync extends AWSRedshiftDataAPI { /** ** 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. *
* * @param batchExecuteStatementRequest * @return A Java Future containing the result of the BatchExecuteStatement operation returned by the service. * @sample AWSRedshiftDataAPIAsync.BatchExecuteStatement * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param batchExecuteStatementRequest * @param 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. * @return A Java Future containing the result of the BatchExecuteStatement operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.BatchExecuteStatement * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param cancelStatementRequest * @return A Java Future containing the result of the CancelStatement operation returned by the service. * @sample AWSRedshiftDataAPIAsync.CancelStatement * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param cancelStatementRequest * @param 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. * @return A Java Future containing the result of the CancelStatement operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.CancelStatement * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeStatementRequest * @return A Java Future containing the result of the DescribeStatement operation returned by the service. * @sample AWSRedshiftDataAPIAsync.DescribeStatement * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeStatementRequest * @param 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. * @return A Java Future containing the result of the DescribeStatement operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.DescribeStatement * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeTableRequest * @return A Java Future containing the result of the DescribeTable operation returned by the service. * @sample AWSRedshiftDataAPIAsync.DescribeTable * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param describeTableRequest * @param 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. * @return A Java Future containing the result of the DescribeTable operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.DescribeTable * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param executeStatementRequest * @return A Java Future containing the result of the ExecuteStatement operation returned by the service. * @sample AWSRedshiftDataAPIAsync.ExecuteStatement * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param executeStatementRequest * @param 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. * @return A Java Future containing the result of the ExecuteStatement operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.ExecuteStatement * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param getStatementResultRequest * @return A Java Future containing the result of the GetStatementResult operation returned by the service. * @sample AWSRedshiftDataAPIAsync.GetStatementResult * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param getStatementResultRequest * @param 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. * @return A Java Future containing the result of the GetStatementResult operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.GetStatementResult * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatabasesRequest * @return A Java Future containing the result of the ListDatabases operation returned by the service. * @sample AWSRedshiftDataAPIAsync.ListDatabases * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listDatabasesRequest * @param 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. * @return A Java Future containing the result of the ListDatabases operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.ListDatabases * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listSchemasRequest * @return A Java Future containing the result of the ListSchemas operation returned by the service. * @sample AWSRedshiftDataAPIAsync.ListSchemas * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listSchemasRequest * @param 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. * @return A Java Future containing the result of the ListSchemas operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.ListSchemas * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param listStatementsRequest * @return A Java Future containing the result of the ListStatements operation returned by the service. * @sample AWSRedshiftDataAPIAsync.ListStatements * @see AWS * API Documentation */ java.util.concurrent.Future* 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. *
* * @param listStatementsRequest * @param 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. * @return A Java Future containing the result of the ListStatements operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.ListStatements * @see AWS * API Documentation */ java.util.concurrent.Future
* 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. *
* * @param listTablesRequest * @return A Java Future containing the result of the ListTables operation returned by the service. * @sample AWSRedshiftDataAPIAsync.ListTables * @see AWS API * Documentation */ java.util.concurrent.Future
* 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. *
* * @param listTablesRequest * @param 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. * @return A Java Future containing the result of the ListTables operation returned by the service. * @sample AWSRedshiftDataAPIAsyncHandler.ListTables * @see AWS API * Documentation */ java.util.concurrent.Future