redshiftdata/aws.sdk.kotlin.services.redshiftdata

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

batchExecuteStatement

inline suspend fun RedshiftDataClient.batchExecuteStatement(crossinline block: BatchExecuteStatementRequest.Builder.() -> Unit): 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

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

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

describeStatement

inline suspend fun RedshiftDataClient.describeStatement(crossinline block: DescribeStatementRequest.Builder.() -> Unit): 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

inline suspend fun RedshiftDataClient.describeTable(crossinline block: DescribeTableRequest.Builder.() -> Unit): 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

inline suspend fun RedshiftDataClient.executeStatement(crossinline block: ExecuteStatementRequest.Builder.() -> Unit): 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

inline suspend fun RedshiftDataClient.getStatementResult(crossinline block: GetStatementResultRequest.Builder.() -> Unit): 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

inline suspend fun RedshiftDataClient.getStatementResultV2(crossinline block: GetStatementResultV2Request.Builder.() -> Unit): 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

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:

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:

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.

listTables

inline suspend fun RedshiftDataClient.listTables(crossinline block: ListTablesRequest.Builder.() -> Unit): 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:

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.