AWSRedshiftDataAPI (AWS Java SDK for Redshift Data API 1.12.770 API)

All Known Subinterfaces:

AWSRedshiftDataAPIAsync

All Known Implementing Classes:

AbstractAWSRedshiftDataAPI, AbstractAWSRedshiftDataAPIAsync, AWSRedshiftDataAPIAsyncClient, AWSRedshiftDataAPIClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSRedshiftDataAPI
```
Interface for accessing Redshift Data API Service.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSRedshiftDataAPI 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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`BatchExecuteStatementResult`	`batchExecuteStatement(BatchExecuteStatementRequest batchExecuteStatementRequest)` Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL).
`CancelStatementResult`	`cancelStatement(CancelStatementRequest cancelStatementRequest)` Cancels a running query.
`DescribeStatementResult`	`describeStatement(DescribeStatementRequest describeStatementRequest)` Describes the details about a specific instance when a query was run by the Amazon Redshift Data API.
`DescribeTableResult`	`describeTable(DescribeTableRequest describeTableRequest)` Describes the detailed information about a table from metadata in the cluster.
`ExecuteStatementResult`	`executeStatement(ExecuteStatementRequest executeStatementRequest)` 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 getStatementResultRequest)` Fetches the temporarily cached result of an SQL statement.
`ListDatabasesResult`	`listDatabases(ListDatabasesRequest listDatabasesRequest)` List the databases in a cluster.
`ListSchemasResult`	`listSchemas(ListSchemasRequest listSchemasRequest)` Lists the schemas in a database.
`ListStatementsResult`	`listStatements(ListStatementsRequest listStatementsRequest)` List of SQL statements.
`ListTablesResult`	`listTables(ListTablesRequest listTablesRequest)` List the tables in a database.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - batchExecuteStatement
```
BatchExecuteStatementResult batchExecuteStatement(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:
    
    Result of the BatchExecuteStatement operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    ActiveStatementsExceededException - The number of active statements exceeds the limit.
    
    BatchExecuteStatementException - An SQL statement encountered an environmental error while running.
    
    See Also:
    
    AWS API Documentation
  - cancelStatement
```
CancelStatementResult cancelStatement(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:
    
    Result of the CancelStatement operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    ResourceNotFoundException - The Amazon Redshift Data API operation failed due to a missing resource.
    
    InternalServerException - The Amazon Redshift Data API operation failed due to invalid input.
    
    DatabaseConnectionException - Connection to a database failed.
    
    See Also:
    
    AWS API Documentation
  - describeStatement
```
DescribeStatementResult describeStatement(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:
    
    Result of the DescribeStatement operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    ResourceNotFoundException - The Amazon Redshift Data API operation failed due to a missing resource.
    
    InternalServerException - The Amazon Redshift Data API operation failed due to invalid input.
    
    See Also:
    
    AWS API Documentation
  - describeTable
```
DescribeTableResult describeTable(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:
    
    Result of the DescribeTable operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    InternalServerException - The Amazon Redshift Data API operation failed due to invalid input.
    
    DatabaseConnectionException - Connection to a database failed.
    
    See Also:
    
    AWS API Documentation
  - executeStatement
```
ExecuteStatementResult executeStatement(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:
    
    Result of the ExecuteStatement operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    ExecuteStatementException - The SQL statement encountered an environmental error while running.
    
    ActiveStatementsExceededException - The number of active statements exceeds the limit.
    
    See Also:
    
    AWS API Documentation
  - getStatementResult
```
GetStatementResultResult getStatementResult(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:
    
    Result of the GetStatementResult operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    ResourceNotFoundException - The Amazon Redshift Data API operation failed due to a missing resource.
    
    InternalServerException - The Amazon Redshift Data API operation failed due to invalid input.
    
    See Also:
    
    AWS API Documentation
  - listDatabases
```
ListDatabasesResult listDatabases(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:
    
    Result of the ListDatabases operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    InternalServerException - The Amazon Redshift Data API operation failed due to invalid input.
    
    DatabaseConnectionException - Connection to a database failed.
    
    See Also:
    
    AWS API Documentation
  - listSchemas
```
ListSchemasResult listSchemas(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:
    
    Result of the ListSchemas operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    InternalServerException - The Amazon Redshift Data API operation failed due to invalid input.
    
    DatabaseConnectionException - Connection to a database failed.
    
    See Also:
    
    AWS API Documentation
  - listStatements
```
ListStatementsResult listStatements(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:
    
    Result of the ListStatements operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    InternalServerException - The Amazon Redshift Data API operation failed due to invalid input.
    
    See Also:
    
    AWS API Documentation
  - listTables
```
ListTablesResult listTables(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:
    
    Result of the ListTables operation returned by the service.
    
    Throws:
    
    ValidationException - The Amazon Redshift Data API operation failed due to invalid input.
    
    InternalServerException - The Amazon Redshift Data API operation failed due to invalid input.
    
    DatabaseConnectionException - Connection to a database failed.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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. 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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Interface AWSRedshiftDataAPI

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

batchExecuteStatement

cancelStatement

describeStatement

describeTable

executeStatement

getStatementResult

listDatabases

listSchemas

listStatements

listTables

shutdown

getCachedResponseMetadata