redshiftdata/aws.sdk.kotlin.services.redshiftdata/RedshiftDataClient

RedshiftDataClient

interface RedshiftDataClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<RedshiftDataClient.Config, RedshiftDataClient.Config.Builder, RedshiftDataClient>

Companion

object Companion : AbstractAwsSdkClientFactory<RedshiftDataClient.Config, RedshiftDataClient.Config.Builder, RedshiftDataClient, RedshiftDataClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: RedshiftDataClient.Config

RedshiftDataClient's configuration

Functions

batchExecuteStatement

abstract suspend fun batchExecuteStatement(input: BatchExecuteStatementRequest): BatchExecuteStatementResponse

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:

cancelStatement

abstract suspend fun cancelStatement(input: CancelStatementRequest): CancelStatementResponse

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

describeStatement

abstract suspend fun describeStatement(input: DescribeStatementRequest): DescribeStatementResponse

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.

describeTable

abstract suspend fun describeTable(input: DescribeTableRequest): DescribeTableResponse

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:

executeStatement

abstract suspend fun executeStatement(input: ExecuteStatementRequest): ExecuteStatementResponse

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:

getStatementResult

abstract suspend fun getStatementResult(input: GetStatementResultRequest): GetStatementResultResponse

Fetches the temporarily cached result of an SQL statement in JSON format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement must have specified ResultFormat as JSON , or let the format default to JSON. A token is returned to page through the statement results.

getStatementResultV2

abstract suspend fun getStatementResultV2(input: GetStatementResultV2Request): GetStatementResultV2Response

Fetches the temporarily cached result of an SQL statement in CSV format. The ExecuteStatement or BatchExecuteStatement operation that ran the SQL statement must have specified ResultFormat as CSV. A token is returned to page through the statement results.

listDatabases

abstract suspend fun listDatabases(input: ListDatabasesRequest): ListDatabasesResponse

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:

listSchemas

abstract suspend fun listSchemas(input: ListSchemasRequest): ListSchemasResponse

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:

listStatements

abstract suspend fun listStatements(input: ListStatementsRequest = ListStatementsRequest { }): ListStatementsResponse

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

listTables

abstract suspend fun listTables(input: ListTablesRequest): ListTablesResponse

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:

Inherited functions

batchExecuteStatement

inline suspend fun RedshiftDataClient.batchExecuteStatement(crossinline block: BatchExecuteStatementRequest.Builder.() -> Unit): BatchExecuteStatementResponse

cancelStatement

inline suspend fun RedshiftDataClient.cancelStatement(crossinline block: CancelStatementRequest.Builder.() -> Unit): CancelStatementResponse

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

expect abstract fun close()

describeStatement

inline suspend fun RedshiftDataClient.describeStatement(crossinline block: DescribeStatementRequest.Builder.() -> Unit): DescribeStatementResponse

describeTable

inline suspend fun RedshiftDataClient.describeTable(crossinline block: DescribeTableRequest.Builder.() -> Unit): DescribeTableResponse

describeTablePaginated

fun RedshiftDataClient.describeTablePaginated(initialRequest: DescribeTableRequest): Flow<DescribeTableResponse>

fun RedshiftDataClient.describeTablePaginated(block: DescribeTableRequest.Builder.() -> Unit): Flow<DescribeTableResponse>

Paginate over DescribeTableResponse results.

executeStatement

inline suspend fun RedshiftDataClient.executeStatement(crossinline block: ExecuteStatementRequest.Builder.() -> Unit): ExecuteStatementResponse

getStatementResult

inline suspend fun RedshiftDataClient.getStatementResult(crossinline block: GetStatementResultRequest.Builder.() -> Unit): GetStatementResultResponse

getStatementResultPaginated

fun RedshiftDataClient.getStatementResultPaginated(initialRequest: GetStatementResultRequest): Flow<GetStatementResultResponse>

fun RedshiftDataClient.getStatementResultPaginated(block: GetStatementResultRequest.Builder.() -> Unit): Flow<GetStatementResultResponse>

Paginate over GetStatementResultResponse results.

getStatementResultV2

inline suspend fun RedshiftDataClient.getStatementResultV2(crossinline block: GetStatementResultV2Request.Builder.() -> Unit): GetStatementResultV2Response

getStatementResultV2Paginated

fun RedshiftDataClient.getStatementResultV2Paginated(initialRequest: GetStatementResultV2Request): Flow<GetStatementResultV2Response>

fun RedshiftDataClient.getStatementResultV2Paginated(block: GetStatementResultV2Request.Builder.() -> Unit): Flow<GetStatementResultV2Response>

Paginate over GetStatementResultV2Response results.

listDatabases

inline suspend fun RedshiftDataClient.listDatabases(crossinline block: ListDatabasesRequest.Builder.() -> Unit): ListDatabasesResponse

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:

listDatabasesPaginated

fun RedshiftDataClient.listDatabasesPaginated(initialRequest: ListDatabasesRequest): Flow<ListDatabasesResponse>

fun RedshiftDataClient.listDatabasesPaginated(block: ListDatabasesRequest.Builder.() -> Unit): Flow<ListDatabasesResponse>

Paginate over ListDatabasesResponse results.

listSchemas

inline suspend fun RedshiftDataClient.listSchemas(crossinline block: ListSchemasRequest.Builder.() -> Unit): ListSchemasResponse

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:

listSchemasPaginated

fun RedshiftDataClient.listSchemasPaginated(initialRequest: ListSchemasRequest): Flow<ListSchemasResponse>

fun RedshiftDataClient.listSchemasPaginated(block: ListSchemasRequest.Builder.() -> Unit): Flow<ListSchemasResponse>

Paginate over ListSchemasResponse results.

listStatements

inline suspend fun RedshiftDataClient.listStatements(crossinline block: ListStatementsRequest.Builder.() -> Unit): ListStatementsResponse

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

listStatementsPaginated

fun RedshiftDataClient.listStatementsPaginated(initialRequest: ListStatementsRequest = ListStatementsRequest { }): Flow<ListStatementsResponse>

fun RedshiftDataClient.listStatementsPaginated(block: ListStatementsRequest.Builder.() -> Unit): Flow<ListStatementsResponse>

Paginate over ListStatementsResponse results.

listTables

inline suspend fun RedshiftDataClient.listTables(crossinline block: ListTablesRequest.Builder.() -> Unit): ListTablesResponse

listTablesPaginated

fun RedshiftDataClient.listTablesPaginated(initialRequest: ListTablesRequest): Flow<ListTablesResponse>

fun RedshiftDataClient.listTablesPaginated(block: ListTablesRequest.Builder.() -> Unit): Flow<ListTablesResponse>

Paginate over ListTablesResponse results.

withConfig

fun RedshiftDataClient.withConfig(block: RedshiftDataClient.Config.Builder.() -> Unit): RedshiftDataClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.