Skip to content

ProtectedQueryS3OutputConfiguration

Source code in docs_src/capo_cleanrooms/types/protected_query_s3_output_configuration.py
class ProtectedQueryS3OutputConfiguration(TypedDict, closed=True):
    result_format: "capo_cleanrooms.types.result_format.ResultFormat"
    """<p>Intended file format of the result.</p>"""
    bucket: "str"
    """<p>The S3 bucket to unload the protected query results.</p>"""
    key_prefix: NotRequired["capo_cleanrooms.types.key_prefix.KeyPrefix"]
    """<p>The S3 prefix to unload the protected query results.</p>"""
    single_file_output: NotRequired["bool"]
    """<p>Indicates whether files should be output as a single file (<code>TRUE</code>) or output as multiple files (<code>FALSE</code>). This parameter is only supported for analyses with the Spark analytics engine.</p>"""

bucket instance-attribute

bucket: str

The S3 bucket to unload the protected query results.

key_prefix instance-attribute

key_prefix: NotRequired[KeyPrefix]

The S3 prefix to unload the protected query results.

result_format instance-attribute

result_format: ResultFormat

Intended file format of the result.

single_file_output instance-attribute

single_file_output: NotRequired[bool]

Indicates whether files should be output as a single file (TRUE) or output as multiple files (FALSE). This parameter is only supported for analyses with the Spark analytics engine.