Skip to content

BatchExecuteStatementOutput

Source code in docs_src/capo_redshift_data/types/batch_execute_statement_output.py
class BatchExecuteStatementOutput(TypedDict, closed=True):
    id: NotRequired["capo_redshift_data.types.uuid.UUID"]
    """<p>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 <code>BatchExecuteStatment</code>. </p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time (UTC) the statement was created. </p>"""
    cluster_identifier: NotRequired[
        "capo_redshift_data.types.cluster_identifier_string.ClusterIdentifierString"
    ]
    """<p>The cluster identifier. This element is not returned when connecting to a serverless workgroup. </p>"""
    db_user: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The database user name.</p>"""
    db_groups: NotRequired["capo_redshift_data.types.db_group_list.DbGroupList"]
    """<p>A list of colon (:) separated names of database groups.</p>"""
    database: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The name of the database.</p>"""
    secret_arn: NotRequired["capo_redshift_data.types.secret_arn.SecretArn"]
    """<p>The name or ARN of the secret that enables access to the database. </p>"""
    workgroup_name: NotRequired[
        "capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
    ]
    """<p>The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.</p>"""
    session_id: NotRequired["capo_redshift_data.types.uuid.UUID"]
    """<p>The session identifier of the query.</p>"""
    status: NotRequired[
        "capo_redshift_data.types.statement_status_string.StatementStatusString"
    ]
    """<p>The status of the SQL statement. Status values are defined as follows: </p> <ul> <li> <p>ABORTED - The query run was stopped by the user. </p> </li> <li> <p>FAILED - The query run failed. </p> </li> <li> <p>FINISHED - The query has finished running. </p> </li> <li> <p>PICKED - The query has been chosen to be run. </p> </li> <li> <p>STARTED - The query run has started. </p> </li> <li> <p>SUBMITTED - The query was submitted, but not yet processed. </p> </li> </ul>"""
    redshift_pid: NotRequired["capo_redshift_data.types.boxed_long.BoxedLong"]
    """<p>The process identifier from Amazon Redshift. </p>"""
    has_result_set: NotRequired["capo_redshift_data.types.boxed_boolean.BoxedBoolean"]
    """<p>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.</p>"""

cluster_identifier instance-attribute

cluster_identifier: NotRequired[ClusterIdentifierString]

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

created_at instance-attribute

created_at: NotRequired[datetime]

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

database instance-attribute

database: NotRequired[String]

The name of the database.

db_groups instance-attribute

db_groups: NotRequired[DbGroupList]

A list of colon (:) separated names of database groups.

db_user instance-attribute

db_user: NotRequired[String]

The database user name.

has_result_set instance-attribute

has_result_set: NotRequired[BoxedBoolean]

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 instance-attribute

id: NotRequired[UUID]

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.

redshift_pid instance-attribute

redshift_pid: NotRequired[BoxedLong]

The process identifier from Amazon Redshift.

secret_arn instance-attribute

secret_arn: NotRequired[SecretArn]

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

session_id instance-attribute

session_id: NotRequired[UUID]

The session identifier of the query.

status instance-attribute

status: NotRequired[StatementStatusString]

The status of the SQL statement. Status values are defined as follows:

  • ABORTED - The query run was stopped by the user.

  • 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.

workgroup_name instance-attribute

workgroup_name: NotRequired[WorkgroupNameString]

The serverless workgroup name or Amazon Resource Name (ARN). This element is not returned when connecting to a provisioned cluster.