@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSRedshiftDataAPIAsync extends AbstractAWSRedshiftDataAPI implements AWSRedshiftDataAPIAsync
AWSRedshiftDataAPIAsync
. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler
, which throws an
UnsupportedOperationException
.ENDPOINT_PREFIX
batchExecuteStatement, cancelStatement, describeStatement, describeTable, executeStatement, getCachedResponseMetadata, getStatementResult, listDatabases, listSchemas, listStatements, listTables, shutdown
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
batchExecuteStatement, cancelStatement, describeStatement, describeTable, executeStatement, getCachedResponseMetadata, getStatementResult, listDatabases, listSchemas, listStatements, listTables, shutdown
public Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest request)
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.
batchExecuteStatementAsync
in interface AWSRedshiftDataAPIAsync
public Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest request, AsyncHandler<BatchExecuteStatementRequest,BatchExecuteStatementResult> asyncHandler)
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.
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.public Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest request)
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.
cancelStatementAsync
in interface AWSRedshiftDataAPIAsync
public Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest request, AsyncHandler<CancelStatementRequest,CancelStatementResult> asyncHandler)
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.
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.public Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest request)
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.
describeStatementAsync
in interface AWSRedshiftDataAPIAsync
public Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest request, AsyncHandler<DescribeStatementRequest,DescribeStatementResult> asyncHandler)
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.
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.public Future<DescribeTableResult> describeTableAsync(DescribeTableRequest request)
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.
describeTableAsync
in interface AWSRedshiftDataAPIAsync
public Future<DescribeTableResult> describeTableAsync(DescribeTableRequest request, AsyncHandler<DescribeTableRequest,DescribeTableResult> asyncHandler)
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.
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.public Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest request)
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.
executeStatementAsync
in interface AWSRedshiftDataAPIAsync
public Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest request, AsyncHandler<ExecuteStatementRequest,ExecuteStatementResult> asyncHandler)
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.
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.public Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest request)
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.
getStatementResultAsync
in interface AWSRedshiftDataAPIAsync
public Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest request, AsyncHandler<GetStatementResultRequest,GetStatementResultResult> asyncHandler)
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.
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.public Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest request)
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.
listDatabasesAsync
in interface AWSRedshiftDataAPIAsync
public Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest request, AsyncHandler<ListDatabasesRequest,ListDatabasesResult> asyncHandler)
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.
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.public Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request)
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.
listSchemasAsync
in interface AWSRedshiftDataAPIAsync
public Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest request, AsyncHandler<ListSchemasRequest,ListSchemasResult> asyncHandler)
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.
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.public Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest request)
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.
listStatementsAsync
in interface AWSRedshiftDataAPIAsync
public Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest request, AsyncHandler<ListStatementsRequest,ListStatementsResult> asyncHandler)
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.
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.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:
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.
listTablesAsync
in interface AWSRedshiftDataAPIAsync
public 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:
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.
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.