String statementId
Statement identifier of the exception.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String clusterIdentifier
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
String database
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
String dbUser
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
String secretArn
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
List<E> sqls
One or more SQL statements to run.
The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.</p>
String statementName
The name of the SQL statements. You can name the SQL statements when you create them to identify the query.
Boolean withEvent
A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.
String workgroupName
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
String clusterIdentifier
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
Date createdAt
The date and time (UTC) the statement was created.
String database
The name of the database.
String dbUser
The database user name.
String id
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.
String secretArn
The name or ARN of the secret that enables access to the database.
String workgroupName
The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.
String id
The identifier of the SQL statement to cancel. This value is a universally unique identifier (UUID) generated by
Amazon Redshift Data API. This identifier is returned by BatchExecuteStatment,
ExecuteStatment, and ListStatements.
Boolean status
A value that indicates whether the cancel statement succeeded (true).
String columnDefault
The default value of the column.
Boolean isCaseSensitive
A value that indicates whether the column is case-sensitive.
Boolean isCurrency
A value that indicates whether the column contains currency values.
Boolean isSigned
A value that indicates whether an integer column is signed.
String label
The label for the column.
Integer length
The length of the column.
String name
The name of the column.
Integer nullable
A value that indicates whether the column is nullable.
Integer precision
The precision value of a decimal number column.
Integer scale
The scale value of a decimal number column.
String schemaName
The name of the schema that contains the table that includes the column.
String tableName
The name of the table that includes the column.
String typeName
The database-specific data type of the column.
String id
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.
String clusterIdentifier
The cluster identifier.
Date createdAt
The date and time (UTC) when the SQL statement was submitted to run.
String database
The name of the database.
String dbUser
The database user name.
Long duration
The amount of time in nanoseconds that the statement ran.
String error
The error message from the cluster if the SQL statement encountered an error while running.
Boolean hasResultSet
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.
String id
The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
List<E> queryParameters
The parameters for the SQL statement.
String queryString
The SQL statement text.
Long redshiftPid
The process identifier from Amazon Redshift.
Long redshiftQueryId
The identifier of the query generated by Amazon Redshift. These identifiers are also available in the
query column of the STL_QUERY system view.
Long resultRows
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.
Long resultSize
The size in bytes of the returned results. A -1 indicates the value is null.
String secretArn
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
String status
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.
List<E> subStatements
The SQL statements from a multiple statement run.
Date updatedAt
The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.
String workgroupName
The serverless workgroup name.
String clusterIdentifier
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
String connectedDatabase
A database name. The connected database is specified when you connect with your authentication credentials.
String database
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 dbUser
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
Integer maxResults
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 nextToken
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 schema
The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.
String secretArn
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
String table
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 workgroupName
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
List<E> columnList
A list of columns in the table.
String nextToken
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 tableName
The table name.
String statementId
Statement identifier of the exception.
String clientToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String clusterIdentifier
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
String database
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
String dbUser
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
List<E> parameters
The parameters for the SQL statement.
String secretArn
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
String sql
The SQL statement text to run.
String statementName
The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
Boolean withEvent
A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.
String workgroupName
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
String clusterIdentifier
The cluster identifier. This element is not returned when connecting to a serverless workgroup.
Date createdAt
The date and time (UTC) the statement was created.
String database
The name of the database.
String dbUser
The database user name.
String id
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.
String secretArn
The name or ARN of the secret that enables access to the database.
String workgroupName
The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.
ByteBuffer blobValue
A value of the BLOB data type.
Boolean booleanValue
A value of the Boolean data type.
Double doubleValue
A value of the double data type.
Boolean isNull
A value that indicates whether the data is NULL.
Long longValue
A value of the long data type.
String stringValue
A value of the string data type.
String id
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. A suffix indicates then 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,
ExecuteStatment, and ListStatements.
String nextToken
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.
List<E> columnMetadata
The properties (metadata) of a column.
String nextToken
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.
List<E> records
The results of the SQL statement.
Long totalNumRows
The total number of rows in the result set returned from a query. You can use this number to estimate the number
of calls to the GetStatementResult operation needed to page through the results.
String clusterIdentifier
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
String database
The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.
String dbUser
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
Integer maxResults
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 nextToken
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 secretArn
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
String workgroupName
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
List<E> databases
The names of databases.
String nextToken
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 clusterIdentifier
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
String connectedDatabase
A database name. The connected database is specified when you connect with your authentication credentials.
String database
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 dbUser
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
Integer maxResults
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 nextToken
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 schemaPattern
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 secretArn
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
String workgroupName
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
String nextToken
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.
List<E> schemas
The schemas that match the request pattern.
Integer maxResults
The maximum number of SQL statements to return in the response. If more SQL statements exist than fit in one
response, then NextToken is returned to page through the results.
String nextToken
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.
Boolean roleLevel
A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.
String statementName
The name of the SQL statement specified as input to BatchExecuteStatement or
ExecuteStatement to identify the query. You can list multiple statements by providing a prefix that
matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and
so on, then provide the a value of myStatement. Data API does a case-sensitive match of SQL
statement names to the prefix value you provide.
String status
The status of the SQL statement to list. 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.
String nextToken
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.
List<E> statements
The SQL statements.
String clusterIdentifier
The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.
String connectedDatabase
A database name. The connected database is specified when you connect with your authentication credentials.
String database
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 dbUser
The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.
Integer maxResults
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 nextToken
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 schemaPattern
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 secretArn
The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.
String tablePattern
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 SchemaPatternare
returned. If neither SchemaPattern or TablePattern are specified, then all tables are
returned.
String workgroupName
The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.
String nextToken
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.
List<E> tables
The tables that match the request pattern.
String resourceId
Resource identifier associated with the exception.
String name
The name of the parameter.
String value
The value of the parameter. Amazon Redshift implicitly converts to the proper data type. For more information, see Data types in the Amazon Redshift Database Developer Guide.
Date createdAt
The date and time (UTC) the statement was created.
String id
The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Boolean isBatchStatement
A value that indicates whether the statement is a batch query request.
List<E> queryParameters
The parameters used in a SQL statement.
String queryString
The SQL statement.
List<E> queryStrings
One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.
String secretArn
The name or Amazon Resource Name (ARN) of the secret that enables access to the database.
String statementName
The name of the SQL statement.
String status
The status of the SQL statement. An example is the that the SQL statement finished.
Date updatedAt
The date and time (UTC) that the statement metadata was last updated.
Date createdAt
The date and time (UTC) the statement was created.
Long duration
The amount of time in nanoseconds that the statement ran.
String error
The error message from the cluster if the SQL statement encountered an error while running.
Boolean hasResultSet
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.
String id
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.
String queryString
The SQL statement text.
Long redshiftQueryId
The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.
Long resultRows
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.
Long resultSize
The size in bytes of the returned results. A -1 indicates the value is null.
String status
The status of the SQL statement. An example is the that the SQL statement finished.
Date updatedAt
The date and time (UTC) that the statement metadata was last updated.
Copyright © 2023. All rights reserved.