Skip to content

StatementData

Source code in docs_src/capo_redshift_data/types/statement_data.py
class StatementData(TypedDict, closed=True):
    id: "capo_redshift_data.types.uuid.UUID"
    """<p>The SQL statement identifier. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>"""
    query_string: NotRequired[
        "capo_redshift_data.types.statement_string.StatementString"
    ]
    """<p>The SQL statement.</p>"""
    query_strings: NotRequired[
        "capo_redshift_data.types.statement_string_list.StatementStringList"
    ]
    """<p>One or more SQL statements. Each query string in the array corresponds to one of the queries in a batch query request.</p>"""
    secret_arn: NotRequired["capo_redshift_data.types.secret_arn.SecretArn"]
    """<p>The name or Amazon Resource Name (ARN) of the secret that enables access to the database. </p>"""
    status: NotRequired["capo_redshift_data.types.status_string.StatusString"]
    """<p>The status of the SQL statement. An example is the that the SQL statement finished. </p>"""
    statement_name: NotRequired[
        "capo_redshift_data.types.statement_name_string.StatementNameString"
    ]
    """<p>The name of the SQL statement. </p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time (UTC) the statement was created. </p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time (UTC) that the statement metadata was last updated.</p>"""
    query_parameters: NotRequired[
        "capo_redshift_data.types.sql_parameters_list.SqlParametersList"
    ]
    """<p>The parameters used in a SQL statement.</p>"""
    is_batch_statement: NotRequired["bool"]
    """<p>A value that indicates whether the statement is a batch query request.</p>"""
    result_format: NotRequired[
        "capo_redshift_data.types.result_format_string.ResultFormatString"
    ]
    """<p>The data format of the result of the SQL statement.</p>"""
    session_id: NotRequired["capo_redshift_data.types.uuid.UUID"]
    """<p>The session identifier of the query.</p>"""

created_at instance-attribute

created_at: NotRequired[datetime]

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

id instance-attribute

id: UUID

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

is_batch_statement instance-attribute

is_batch_statement: NotRequired[bool]

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

query_parameters instance-attribute

query_parameters: NotRequired[SqlParametersList]

The parameters used in a SQL statement.

query_string instance-attribute

query_string: NotRequired[StatementString]

The SQL statement.

query_strings instance-attribute

query_strings: NotRequired[StatementStringList]

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

result_format instance-attribute

result_format: NotRequired[ResultFormatString]

The data format of the result of the SQL statement.

secret_arn instance-attribute

secret_arn: NotRequired[SecretArn]

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

session_id instance-attribute

session_id: NotRequired[UUID]

The session identifier of the query.

statement_name instance-attribute

statement_name: NotRequired[StatementNameString]

The name of the SQL statement.

status instance-attribute

status: NotRequired[StatusString]

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

updated_at instance-attribute

updated_at: NotRequired[datetime]

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