2022/06/16 - Redshift Data API Service - 7 updated api methods
Changes This release adds a new --workgroup-name field to operations that connect to an endpoint. Customers can now execute queries against their serverless workgroups.
{'WorkgroupName': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.batch_execute_statement(
ClusterIdentifier='string',
Database='string',
DbUser='string',
SecretArn='string',
Sqls=[
'string',
],
StatementName='string',
WithEvent=True|False,
WorkgroupName='string'
)
string
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
string
[REQUIRED]
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
string
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
string
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
list
[REQUIRED]
One or more SQL statements to run.
(string) --
string
The name of the SQL statements. You can name the SQL statements when you create them to identify the query.
boolean
A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
string
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
dict
Response Syntax
{
'ClusterIdentifier': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Database': 'string',
'DbUser': 'string',
'Id': 'string',
'SecretArn': 'string',
'WorkgroupName': 'string'
}
Response Structure
(dict) --
ClusterIdentifier (string) --
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
CreatedAt (datetime) --
The date and time (UTC) the statement was created.
Database (string) --
The name of the database.
DbUser (string) --
The database user name.
Id (string) --
The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment.
SecretArn (string) --
The name or ARN of the secret that enables access to the database.
WorkgroupName (string) --
The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.
{'WorkgroupName': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.describe_statement(
Id='string'
)
string
[REQUIRED]
The identifier of the SQL statement to describe. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query. This identifier is returned by BatchExecuteStatment, ExecuteStatement, and ListStatements.
dict
Response Syntax
{
'ClusterIdentifier': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Database': 'string',
'DbUser': 'string',
'Duration': 123,
'Error': 'string',
'HasResultSet': True|False,
'Id': 'string',
'QueryParameters': [
{
'name': 'string',
'value': 'string'
},
],
'QueryString': 'string',
'RedshiftPid': 123,
'RedshiftQueryId': 123,
'ResultRows': 123,
'ResultSize': 123,
'SecretArn': 'string',
'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED'|'ALL',
'SubStatements': [
{
'CreatedAt': datetime(2015, 1, 1),
'Duration': 123,
'Error': 'string',
'HasResultSet': True|False,
'Id': 'string',
'QueryString': 'string',
'RedshiftQueryId': 123,
'ResultRows': 123,
'ResultSize': 123,
'Status': 'SUBMITTED'|'PICKED'|'STARTED'|'FINISHED'|'ABORTED'|'FAILED',
'UpdatedAt': datetime(2015, 1, 1)
},
],
'UpdatedAt': datetime(2015, 1, 1),
'WorkgroupName': 'string'
}
Response Structure
(dict) --
ClusterIdentifier (string) --
The cluster identifier.
CreatedAt (datetime) --
The date and time (UTC) when the SQL statement was submitted to run.
Database (string) --
The name of the database.
DbUser (string) --
The database user name.
Duration (integer) --
The amount of time in nanoseconds that the statement ran.
Error (string) --
The error message from the cluster if the SQL statement encountered an error while running.
HasResultSet (boolean) --
A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.
Id (string) --
The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
QueryParameters (list) --
The parameters for the SQL statement.
(dict) --
A parameter used in a SQL statement.
name (string) --
The name of the parameter.
value (string) --
The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more inforation, see Data types in the Amazon Redshift Database Developer Guide.
QueryString (string) --
The SQL statement text.
RedshiftPid (integer) --
The process identifier from Amazon Redshift.
RedshiftQueryId (integer) --
The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.
ResultRows (integer) --
Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.
ResultSize (integer) --
The size in bytes of the returned results. A -1 indicates the value is null.
SecretArn (string) --
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
Status (string) --
The status of the SQL statement being described. Status values are defined as follows:
ABORTED - The query run was stopped by the user.
ALL - A status value that includes all query statuses. This value can be used to filter results.
FAILED - The query run failed.
FINISHED - The query has finished running.
PICKED - The query has been chosen to be run.
STARTED - The query run has started.
SUBMITTED - The query was submitted, but not yet processed.
SubStatements (list) --
The SQL statements from a multiple statement run.
(dict) --
Information about an SQL statement.
CreatedAt (datetime) --
The date and time (UTC) the statement was created.
Duration (integer) --
The amount of time in nanoseconds that the statement ran.
Error (string) --
The error message from the cluster if the SQL statement encountered an error while running.
HasResultSet (boolean) --
A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.
Id (string) --
The identifier of the SQL statement. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. A suffix indicates the number of the SQL statement. For example, d9b6c0c9-0747-4bf4-b142-e8883122f766:2 has a suffix of :2 that indicates the second SQL statement of a batch query.
QueryString (string) --
The SQL statement text.
RedshiftQueryId (integer) --
The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
ResultRows (integer) --
Either the number of rows returned from the SQL statement or the number of rows affected. If result size is greater than zero, the result rows can be the number of rows affected by SQL statements such as INSERT, UPDATE, DELETE, COPY, and others. A -1 indicates the value is null.
ResultSize (integer) --
The size in bytes of the returned results. A -1 indicates the value is null.
Status (string) --
The status of the SQL statement. An example is the that the SQL statement finished.
UpdatedAt (datetime) --
The date and time (UTC) that the statement metadata was last updated.
UpdatedAt (datetime) --
The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
WorkgroupName (string) --
The serverless workgroup name.
{'WorkgroupName': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.describe_table(
ClusterIdentifier='string',
ConnectedDatabase='string',
Database='string',
DbUser='string',
MaxResults=123,
NextToken='string',
Schema='string',
SecretArn='string',
Table='string',
WorkgroupName='string'
)
string
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
string
A database name. The connected database is specified when you connect with your authentication credentials.
string
[REQUIRED]
The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
string
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
integer
The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
string
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
string
The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
string
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
string
The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned
string
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
dict
Response Syntax
{
'ColumnList': [
{
'columnDefault': 'string',
'isCaseSensitive': True|False,
'isCurrency': True|False,
'isSigned': True|False,
'label': 'string',
'length': 123,
'name': 'string',
'nullable': 123,
'precision': 123,
'scale': 123,
'schemaName': 'string',
'tableName': 'string',
'typeName': 'string'
},
],
'NextToken': 'string',
'TableName': 'string'
}
Response Structure
(dict) --
ColumnList (list) --
A list of columns in the table.
(dict) --
The properties (metadata) of a column.
columnDefault (string) --
The default value of the column.
isCaseSensitive (boolean) --
A value that indicates whether the column is case-sensitive.
isCurrency (boolean) --
A value that indicates whether the column contains currency values.
isSigned (boolean) --
A value that indicates whether an integer column is signed.
label (string) --
The label for the column.
length (integer) --
The length of the column.
name (string) --
The name of the column.
nullable (integer) --
A value that indicates whether the column is nullable.
precision (integer) --
The precision value of a decimal number column.
scale (integer) --
The scale value of a decimal number column.
schemaName (string) --
The name of the schema that contains the table that includes the column.
tableName (string) --
The name of the table that includes the column.
typeName (string) --
The database-specific data type of the column.
NextToken (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
TableName (string) --
The table name.
{'WorkgroupName': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.execute_statement(
ClusterIdentifier='string',
Database='string',
DbUser='string',
Parameters=[
{
'name': 'string',
'value': 'string'
},
],
SecretArn='string',
Sql='string',
StatementName='string',
WithEvent=True|False,
WorkgroupName='string'
)
string
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
string
[REQUIRED]
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
string
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
list
The parameters for the SQL statement.
(dict) --
A parameter used in a SQL statement.
name (string) -- [REQUIRED]
The name of the parameter.
value (string) -- [REQUIRED]
The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more inforation, see Data types in the Amazon Redshift Database Developer Guide.
string
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
string
[REQUIRED]
The SQL statement text to run.
string
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
boolean
A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
string
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
dict
Response Syntax
{
'ClusterIdentifier': 'string',
'CreatedAt': datetime(2015, 1, 1),
'Database': 'string',
'DbUser': 'string',
'Id': 'string',
'SecretArn': 'string',
'WorkgroupName': 'string'
}
Response Structure
(dict) --
ClusterIdentifier (string) --
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
CreatedAt (datetime) --
The date and time (UTC) the statement was created.
Database (string) --
The name of the database.
DbUser (string) --
The database user name.
Id (string) --
The identifier of the SQL statement whose results are to be fetched. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
SecretArn (string) --
The name or ARN of the secret that enables access to the database.
WorkgroupName (string) --
The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.
{'WorkgroupName': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.list_databases(
ClusterIdentifier='string',
Database='string',
DbUser='string',
MaxResults=123,
NextToken='string',
SecretArn='string',
WorkgroupName='string'
)
string
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
string
[REQUIRED]
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
string
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
integer
The maximum number of databases to return in the response. If more databases exist than fit in one response, then NextToken is returned to page through the results.
string
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
string
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
string
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
dict
Response Syntax
{
'Databases': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
Databases (list) --
The names of databases.
(string) --
NextToken (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
{'WorkgroupName': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.list_schemas(
ClusterIdentifier='string',
ConnectedDatabase='string',
Database='string',
DbUser='string',
MaxResults=123,
NextToken='string',
SchemaPattern='string',
SecretArn='string',
WorkgroupName='string'
)
string
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
string
A database name. The connected database is specified when you connect with your authentication credentials.
string
[REQUIRED]
The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
string
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
integer
The maximum number of schemas to return in the response. If more schemas exist than fit in one response, then NextToken is returned to page through the results.
string
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
string
A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned.
string
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
string
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
dict
Response Syntax
{
'NextToken': 'string',
'Schemas': [
'string',
]
}
Response Structure
(dict) --
NextToken (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
Schemas (list) --
The schemas that match the request pattern.
(string) --
{'WorkgroupName': 'string'}
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.
See also: AWS API Documentation
Request Syntax
client.list_tables(
ClusterIdentifier='string',
ConnectedDatabase='string',
Database='string',
DbUser='string',
MaxResults=123,
NextToken='string',
SchemaPattern='string',
SecretArn='string',
TablePattern='string',
WorkgroupName='string'
)
string
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
string
A database name. The connected database is specified when you connect with your authentication credentials.
string
[REQUIRED]
The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.
string
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
integer
The maximum number of tables to return in the response. If more tables exist than fit in one response, then NextToken is returned to page through the results.
string
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
string
A pattern to filter results by schema name. Within a schema pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.
string
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
string
A pattern to filter results by table name. Within a table pattern, "%" means match any substring of 0 or more characters and "_" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPattern``are returned. If neither ``SchemaPattern or TablePattern are specified, then all tables are returned.
string
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
dict
Response Syntax
{
'NextToken': 'string',
'Tables': [
{
'name': 'string',
'schema': 'string',
'type': 'string'
},
]
}
Response Structure
(dict) --
NextToken (string) --
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.
Tables (list) --
The tables that match the request pattern.
(dict) --
The properties of a table.
name (string) --
The name of the table.
schema (string) --
The schema containing the table.
type (string) --
The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.