Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

RedshiftData

import { RedshiftData } from "https://aws-api.deno.dev/v0.4/services/redshiftdata.ts?docs=full";
class RedshiftData {
constructor(apiFactory: client.ApiFactory);
async batchExecuteStatement(params: BatchExecuteStatementInput, opts?: client.RequestOptions): Promise<BatchExecuteStatementOutput>;
async cancelStatement(params: CancelStatementRequest, opts?: client.RequestOptions): Promise<CancelStatementResponse>;
async describeStatement(params: DescribeStatementRequest, opts?: client.RequestOptions): Promise<DescribeStatementResponse>;
async describeTable(params: DescribeTableRequest, opts?: client.RequestOptions): Promise<DescribeTableResponse>;
async executeStatement(params: ExecuteStatementInput, opts?: client.RequestOptions): Promise<ExecuteStatementOutput>;
async getStatementResult(params: GetStatementResultRequest, opts?: client.RequestOptions): Promise<GetStatementResultResponse>;
async listDatabases(params: ListDatabasesRequest, opts?: client.RequestOptions): Promise<ListDatabasesResponse>;
async listSchemas(params: ListSchemasRequest, opts?: client.RequestOptions): Promise<ListSchemasResponse>;
async listStatements(params?: ListStatementsRequest, opts?: client.RequestOptions): Promise<ListStatementsResponse>;
async listTables(params: ListTablesRequest, opts?: client.RequestOptions): Promise<ListTablesResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new RedshiftData(apiFactory: client.ApiFactory)
[src]

§Methods

§
batchExecuteStatement(params: BatchExecuteStatementInput, opts?: client.RequestOptions): Promise<BatchExecuteStatementOutput>
[src]

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, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials 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.

§
cancelStatement(params: CancelStatementRequest, opts?: client.RequestOptions): Promise<CancelStatementResponse>
[src]

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.

§
describeStatement(params: DescribeStatementRequest, opts?: client.RequestOptions): Promise<DescribeStatementResponse>
[src]

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.

§
describeTable(params: DescribeTableRequest, opts?: client.RequestOptions): Promise<DescribeTableResponse>
[src]

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, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials 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.

§
executeStatement(params: ExecuteStatementInput, opts?: client.RequestOptions): Promise<ExecuteStatementOutput>
[src]

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, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials 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.

§
getStatementResult(params: GetStatementResultRequest, opts?: client.RequestOptions): Promise<GetStatementResultResponse>
[src]

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.

§
listDatabases(params: ListDatabasesRequest, opts?: client.RequestOptions): Promise<ListDatabasesResponse>
[src]

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, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials 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.

§
listSchemas(params: ListSchemasRequest, opts?: client.RequestOptions): Promise<ListSchemasResponse>
[src]

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, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials 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.

§
listStatements(params?: ListStatementsRequest, opts?: client.RequestOptions): Promise<ListStatementsResponse>
[src]

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.

§
listTables(params: ListTablesRequest, opts?: client.RequestOptions): Promise<ListTablesResponse>
[src]

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, specify the Amazon Resource Name (ARN) of the secret, the database name, and the cluster identifier that matches the cluster in the secret. When connecting to a serverless workgroup, specify the Amazon Resource Name (ARN) of the secret and the database name.
  • Temporary credentials - when connecting to a cluster, specify the cluster identifier, the database name, and the database user name. Also, permission to call the redshift:GetClusterCredentials operation is required. When connecting to a serverless workgroup, specify the workgroup name and database name. Also, permission to call the redshift-serverless:GetCredentials 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.

§Static Properties