View Source AWS.RedshiftData (aws-elixir v1.0.4)
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.
Link to this section Summary
Functions
Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL).
Cancels a running query.
Describes the details about a specific instance when a query was run by the Amazon Redshift Data API.
Describes the detailed information about a table from metadata in the cluster.
Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL).
Fetches the temporarily cached result of an SQL statement in JSON format.
Fetches the temporarily cached result of an SQL statement in CSV format.
List the databases in a cluster.
Lists the schemas in a database.
List of SQL statements.
List the tables in a database.
Link to this section Functions
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.