Skip to content

ExecuteStatementResponse

Source code in docs_src/capo_rds_data/types/execute_statement_response.py
class ExecuteStatementResponse(TypedDict, closed=True):
    records: NotRequired["capo_rds_data.types.sql_records.SqlRecords"]
    """<p>The records returned by the SQL statement. This field is blank if the <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p>"""
    column_metadata: NotRequired["capo_rds_data.types.metadata.Metadata"]
    """<p>Metadata for the columns included in the results. This field is blank if the <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p>"""
    number_of_records_updated: "capo_rds_data.types.records_updated.RecordsUpdated"
    """<p>The number of records updated by the request.</p>"""
    generated_fields: NotRequired["capo_rds_data.types.field_list.FieldList"]
    """<p>Values for fields generated during a DML request.</p> <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note>"""
    formatted_records: NotRequired[
        "capo_rds_data.types.formatted_sql_records.FormattedSqlRecords"
    ]
    """<p>A string value that represents the result set of a <code>SELECT</code> statement in JSON format. This value is only present when the <code>formatRecordsAs</code> parameter is set to <code>JSON</code>.</p> <p>The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.</p>"""

column_metadata instance-attribute

column_metadata: NotRequired[Metadata]

Metadata for the columns included in the results. This field is blank if the formatRecordsAs parameter is set to JSON.

formatted_records instance-attribute

formatted_records: NotRequired[FormattedSqlRecords]

A string value that represents the result set of a SELECT statement in JSON format. This value is only present when the formatRecordsAs parameter is set to JSON.

The size limit for this field is currently 10 MB. If the JSON-formatted string representing the result set requires more than 10 MB, the call returns an error.

generated_fields instance-attribute

generated_fields: NotRequired[FieldList]

Values for fields generated during a DML request.

The generatedFields data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the RETURNING clause. For more information, see Returning Data From Modified Rows in the PostgreSQL documentation.

number_of_records_updated instance-attribute

number_of_records_updated: RecordsUpdated

The number of records updated by the request.

records instance-attribute

records: NotRequired[SqlRecords]

The records returned by the SQL statement. This field is blank if the formatRecordsAs parameter is set to JSON.