All Implemented Interfaces:

AWSRedshiftDataAPI

Direct Known Subclasses:

AbstractAWSRedshiftDataAPIAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSRedshiftDataAPI
extends Object
implements AWSRedshiftDataAPI 

• Field Summary

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

    ENDPOINT_PREFIX

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  BatchExecuteStatementResult	batchExecuteStatement (BatchExecuteStatementRequest request) Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL).
  CancelStatementResult	cancelStatement (CancelStatementRequest request) Cancels a running query.
  DescribeStatementResult	describeStatement (DescribeStatementRequest request) Describes the details about a specific instance when a query was run by the Amazon Redshift Data API.
  DescribeTableResult	describeTable (DescribeTableRequest request) Describes the detailed information about a table from metadata in the cluster.
  ExecuteStatementResult	executeStatement (ExecuteStatementRequest request) Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL).
  ResponseMetadata	getCachedResponseMetadata (AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
  GetStatementResultResult	getStatementResult (GetStatementResultRequest request) Fetches the temporarily cached result of an SQL statement.
  ListDatabasesResult	listDatabases (ListDatabasesRequest request) List the databases in a cluster.
  ListSchemasResult	listSchemas (ListSchemasRequest request) Lists the schemas in a database.
  ListStatementsResult	listStatements (ListStatementsRequest request) List of SQL statements.
  ListTablesResult	listTables (ListTablesRequest request) List the tables in a database.
  void	shutdown () Shuts down this client object, releasing any resources that might be held open.

  • Methods inherited from class java.lang.Object

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

• Method Detail

  • batchExecuteStatement

    public BatchExecuteStatementResult batchExecuteStatement(BatchExecuteStatementRequest request)

    Description copied from interface: 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.

    Specified by:

    batchExecuteStatement in interface AWSRedshiftDataAPI

    Returns:

    Result of the BatchExecuteStatement operation returned by the service.

    See Also:

    AWS API Documentation

  • cancelStatement

    public CancelStatementResult cancelStatement(CancelStatementRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

    Specified by:

    cancelStatement in interface AWSRedshiftDataAPI

    Returns:

    Result of the CancelStatement operation returned by the service.

    See Also:

    AWS API Documentation

  • describeStatement

    public DescribeStatementResult describeStatement(DescribeStatementRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

    Specified by:

    describeStatement in interface AWSRedshiftDataAPI

    Returns:

    Result of the DescribeStatement operation returned by the service.

    See Also:

    AWS API Documentation

  • describeTable

    public DescribeTableResult describeTable(DescribeTableRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

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

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

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

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

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

    Specified by:

    describeTable in interface AWSRedshiftDataAPI

    Returns:

    Result of the DescribeTable operation returned by the service.

    See Also:

    AWS API Documentation

  • executeStatement

    public ExecuteStatementResult executeStatement(ExecuteStatementRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

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

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

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

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

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

    Specified by:

    executeStatement in interface AWSRedshiftDataAPI

    Returns:

    Result of the ExecuteStatement operation returned by the service.

    See Also:

    AWS API Documentation

  • getStatementResult

    public GetStatementResultResult getStatementResult(GetStatementResultRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

    Specified by:

    getStatementResult in interface AWSRedshiftDataAPI

    Returns:

    Result of the GetStatementResult operation returned by the service.

    See Also:

    AWS API Documentation

  • listDatabases

    public ListDatabasesResult listDatabases(ListDatabasesRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

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

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

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

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

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

    Specified by:

    listDatabases in interface AWSRedshiftDataAPI

    Returns:

    Result of the ListDatabases operation returned by the service.

    See Also:

    AWS API Documentation

  • listSchemas

    public ListSchemasResult listSchemas(ListSchemasRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

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

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

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

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

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

    Specified by:

    listSchemas in interface AWSRedshiftDataAPI

    Returns:

    Result of the ListSchemas operation returned by the service.

    See Also:

    AWS API Documentation

  • listStatements

    public ListStatementsResult listStatements(ListStatementsRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

    Specified by:

    listStatements in interface AWSRedshiftDataAPI

    Returns:

    Result of the ListStatements operation returned by the service.

    See Also:

    AWS API Documentation

  • listTables

    public ListTablesResult listTables(ListTablesRequest request)

    Description copied from interface: AWSRedshiftDataAPI

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

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

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

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

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

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

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

    Specified by:

    listTables in interface AWSRedshiftDataAPI

    Returns:

    Result of the ListTables operation returned by the service.

    See Also:

    AWS API Documentation

  • shutdown

    public void shutdown()

    Description copied from interface: AWSRedshiftDataAPI
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

    Specified by:

    shutdown in interface AWSRedshiftDataAPI

  • getCachedResponseMetadata

    public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

    Description copied from interface: AWSRedshiftDataAPI
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

    Specified by:

    getCachedResponseMetadata in interface AWSRedshiftDataAPI

    Parameters:

    request - The originally executed request.

    Returns:

    The response metadata for the specified request, or null if none is available.