A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

The name of the SQL statements. You can name the SQL statements when you create them to identify the query.

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

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>

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

The date and time (UTC) the statement was created.

The name of the database.

The database user name.

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.

The name or ARN of the secret that enables access to the database.

The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.

The response's http status code.

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.

A value that indicates whether the cancel statement succeeded (true).

The response's http status code.

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.

The cluster identifier.

The date and time (UTC) when the SQL statement was submitted to run.

The name of the database.

The database user name.

The amount of time in nanoseconds that the statement ran.

The error message from the cluster if the SQL statement encountered an error while running.

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.

The parameters for the SQL statement.

The SQL statement text.

The process identifier from Amazon Redshift.

The identifier of the query generated by Amazon Redshift. These identifiers are also available in the query column of the STL_QUERY system view.

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.

The size in bytes of the returned results. A -1 indicates the value is null.

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

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.

The SQL statements from a multiple statement run.

The date and time (UTC) that the metadata for the SQL statement was last updated. An example is the time the status last changed.

The serverless workgroup name.

The response's http status code.

The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

A database name. The connected database is specified when you connect with your authentication credentials.

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

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.

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.

The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

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

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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.

A list of columns in the table.

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.

The table name.

The response's http status code.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

The parameters for the SQL statement.

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

The SQL statement text to run.

The cluster identifier. This element is not returned when connecting to a serverless workgroup.

The date and time (UTC) the statement was created.

The name of the database.

The database user name.

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.

The name or ARN of the secret that enables access to the database.

The serverless workgroup name. This element is not returned when connecting to a provisioned cluster.

The response's http status code.

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.

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.

The properties (metadata) of a column.

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.

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.

The response's http status code.

The results of the SQL statement.

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

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.

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.

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

The names of databases.

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.

The response's http status code.

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

A database name. The connected database is specified when you connect with your authentication credentials.

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

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.

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.

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.

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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.

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.

The schemas that match the request pattern.

The response's http status code.

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.

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.

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.

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.

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.

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.

The response's http status code.

The SQL statements.

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

A database name. The connected database is specified when you connect with your authentication credentials.

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

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.

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.

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.

The name or ARN of the secret that enables access to the database. This parameter is required when authenticating using Secrets Manager.

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.

The serverless workgroup name. This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.

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.

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.

The tables that match the request pattern.

The response's http status code.

The default value of the column.

A value that indicates whether the column is case-sensitive.

A value that indicates whether the column contains currency values.

A value that indicates whether an integer column is signed.

The label for the column.

The length of the column.

The name of the column.

A value that indicates whether the column is nullable.

The precision value of a decimal number column.

The scale value of a decimal number column.

The name of the schema that contains the table that includes the column.

The name of the table that includes the column.

The database-specific data type of the column.

A value of the BLOB data type.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

A value of the Boolean data type.

A value of the double data type.

A value that indicates whether the data is NULL.

A value of the long data type.

A value of the string data type.

The name of the parameter.

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.

The date and time (UTC) the statement was created.

A value that indicates whether the statement is a batch query request.

The parameters used in a SQL statement.

The SQL statement.

One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.

The name or Amazon Resource Name (ARN) of the secret that enables access to the database.

The name of the SQL statement.

The status of the SQL statement. An example is the that the SQL statement finished.

The date and time (UTC) that the statement metadata was last updated.

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

The date and time (UTC) the statement was created.

The amount of time in nanoseconds that the statement ran.

The error message from the cluster if the SQL statement encountered an error while running.

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 SQL statement text.

The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API.

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.

The size in bytes of the returned results. A -1 indicates the value is null.

The status of the SQL statement. An example is the that the SQL statement finished.

The date and time (UTC) that the statement metadata was last updated.

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.

The name of the table.

The schema containing the table.

The type of the table. Possible values include TABLE, VIEW, SYSTEM TABLE, GLOBAL TEMPORARY, LOCAL TEMPORARY, ALIAS, and SYNONYM.