All Superinterfaces:

AWSRedshiftDataAPI

All Known Implementing Classes:

AbstractAWSRedshiftDataAPIAsync, AWSRedshiftDataAPIAsyncClient

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

• Field Summary

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

    ENDPOINT_PREFIX

• Method Summary

  All Methods

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

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

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

• Method Detail

  • batchExecuteStatementAsync

    Future<BatchExecuteStatementResult> batchExecuteStatementAsync(BatchExecuteStatementRequest batchExecuteStatementRequest)

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

    • Secrets Manager - 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.

    Parameters:

    batchExecuteStatementRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • batchExecuteStatementAsync

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

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

    • Secrets Manager - 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.

    Parameters:

    batchExecuteStatementRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • cancelStatementAsync

    Future<CancelStatementResult> cancelStatementAsync(CancelStatementRequest cancelStatementRequest)

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

    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.

    Parameters:

    cancelStatementRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • cancelStatementAsync

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

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

    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.

    Parameters:

    cancelStatementRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • describeStatementAsync

    Future<DescribeStatementResult> describeStatementAsync(DescribeStatementRequest describeStatementRequest)

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

    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.

    Parameters:

    describeStatementRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • describeStatementAsync

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

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

    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.

    Parameters:

    describeStatementRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • describeTableAsync

    Future<DescribeTableResult> describeTableAsync(DescribeTableRequest describeTableRequest)

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

    • Secrets Manager - 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.

    Parameters:

    describeTableRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • describeTableAsync

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

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

    • Secrets Manager - 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.

    Parameters:

    describeTableRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • executeStatementAsync

    Future<ExecuteStatementResult> executeStatementAsync(ExecuteStatementRequest executeStatementRequest)

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

    • Secrets Manager - 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.

    Parameters:

    executeStatementRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • executeStatementAsync

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

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

    • Secrets Manager - 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.

    Parameters:

    executeStatementRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • getStatementResultAsync

    Future<GetStatementResultResult> getStatementResultAsync(GetStatementResultRequest getStatementResultRequest)

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

    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.

    Parameters:

    getStatementResultRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • getStatementResultAsync

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

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

    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.

    Parameters:

    getStatementResultRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • listDatabasesAsync

    Future<ListDatabasesResult> listDatabasesAsync(ListDatabasesRequest listDatabasesRequest)

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

    • Secrets Manager - 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.

    Parameters:

    listDatabasesRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • listDatabasesAsync

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

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

    • Secrets Manager - 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.

    Parameters:

    listDatabasesRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • listSchemasAsync

    Future<ListSchemasResult> listSchemasAsync(ListSchemasRequest listSchemasRequest)

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

    • Secrets Manager - 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.

    Parameters:

    listSchemasRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • listSchemasAsync

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

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

    • Secrets Manager - 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.

    Parameters:

    listSchemasRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • listStatementsAsync

    Future<ListStatementsResult> listStatementsAsync(ListStatementsRequest listStatementsRequest)

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

    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.

    Parameters:

    listStatementsRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • listStatementsAsync

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

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

    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.

    Parameters:

    listStatementsRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation

  • listTablesAsync

    Future<ListTablesResult> listTablesAsync(ListTablesRequest listTablesRequest)

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

    • Secrets Manager - 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.

    Parameters:

    listTablesRequest -

    Returns:

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

    See Also:

    AWS API Documentation

  • listTablesAsync

    Future<ListTablesResult> listTablesAsync(ListTablesRequest listTablesRequest,
     AsyncHandler<ListTablesRequest,ListTablesResult> asyncHandler)

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

    • Secrets Manager - 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.

    Parameters:

    listTablesRequest -

    asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

    Returns:

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

    See Also:

    AWS API Documentation