ExecuteStatementInput ¶

class ExecuteStatementInput(TypedDict, closed=True):
    sql: "capo_redshift_data.types.statement_string.StatementString"
    """<p>The SQL statement text to run. </p>"""
    cluster_identifier: NotRequired[
        "capo_redshift_data.types.cluster_identifier_string.ClusterIdentifierString"
    ]
    """<p>The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. </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. This parameter is required when authenticating using Secrets Manager. </p>"""
    db_user: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The database user name. This parameter is required when connecting to a cluster as a database user and authenticating using temporary credentials. </p>"""
    database: NotRequired["capo_redshift_data.types.string.String"]
    """<p>The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials. </p>"""
    with_event: NotRequired["bool"]
    """<p>A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs. </p>"""
    statement_name: NotRequired[
        "capo_redshift_data.types.statement_name_string.StatementNameString"
    ]
    """<p>The name of the SQL statement. You can name the SQL statement when you create it to identify the query. </p>"""
    parameters: NotRequired[
        "capo_redshift_data.types.sql_parameters_list.SqlParametersList"
    ]
    """<p>The parameters for the SQL statement.</p>"""
    workgroup_name: NotRequired[
        "capo_redshift_data.types.workgroup_name_string.WorkgroupNameString"
    ]
    """<p>The serverless workgroup name or Amazon Resource Name (ARN). This parameter is required when connecting to a serverless workgroup and authenticating using either Secrets Manager or temporary credentials.</p>"""
    client_token: NotRequired["capo_redshift_data.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""
    result_format: NotRequired[
        "capo_redshift_data.types.result_format_string.ResultFormatString"
    ]
    """<p>The data format of the result of the SQL statement. If no format is specified, the default is JSON.</p>"""
    session_keep_alive_seconds: NotRequired[
        "capo_redshift_data.types.session_alive_seconds.SessionAliveSeconds"
    ]
    """<p>The number of seconds to keep the session alive after the query finishes. The maximum time a session can keep alive is 24 hours. After 24 hours, the session is forced closed and the query is terminated.</p>"""
    session_id: NotRequired["capo_redshift_data.types.uuid.UUID"]
    """<p>The session identifier of the query.</p>"""
    wait_time_seconds: NotRequired[
        "capo_redshift_data.types.wait_time_seconds.WaitTimeSeconds"
    ]
    """<p>The number of seconds to wait for the SQL statement to complete execution before returning the response. If the SQL statement does not complete within the specified time, the response returns the current status. The maximum value is 30 seconds.</p>"""