SelectObjectContentRequest ¶

class SelectObjectContentRequest(TypedDict, closed=True):
    bucket: "capo_s3.types.bucket_name.BucketName"
    """<p>The S3 bucket.</p>"""
    key: "capo_s3.types.object_key.ObjectKey"
    """<p>The object key.</p>"""
    sse_customer_algorithm: NotRequired[
        "capo_s3.types.sse_customer_algorithm.SSECustomerAlgorithm"
    ]
    """<p>The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>"""
    sse_customer_key: NotRequired["capo_s3.types.sse_customer_key.SSECustomerKey"]
    """<p>The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>"""
    sse_customer_key_md5: NotRequired[
        "capo_s3.types.sse_customer_key_md5.SSECustomerKeyMD5"
    ]
    """<p>The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Protecting data using SSE-C keys</a> in the <i>Amazon S3 User Guide</i>.</p>"""
    expression: "capo_s3.types.expression.Expression"
    """<p>The expression that is used to query the object.</p>"""
    expression_type: "capo_s3.types.expression_type.ExpressionType"
    """<p>The type of the provided expression (for example, SQL).</p>"""
    request_progress: NotRequired["capo_s3.types.request_progress.RequestProgress"]
    """<p>Specifies if periodic request progress information should be enabled.</p>"""
    input_serialization: "capo_s3.types.input_serialization.InputSerialization"
    """<p>Describes the format of the data in the object that is being queried.</p>"""
    output_serialization: "capo_s3.types.output_serialization.OutputSerialization"
    """<p>Describes the format of the data that you want Amazon S3 to return in response.</p>"""
    scan_range: NotRequired["capo_s3.types.scan_range.ScanRange"]
    """<p>Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.</p> <p> <code>ScanRange</code>may be used in the following ways:</p> <ul> <li> <p> <code><scanrange><start>50</start><end>100</end></scanrange></code> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)</p> </li> <li> <p> <code><scanrange><start>50</start></scanrange></code> - process only the records starting after the byte 50</p> </li> <li> <p> <code><scanrange><end>50</end></scanrange></code> - process only the records within the last 50 bytes of the file.</p> </li> </ul>"""
    expected_bucket_owner: NotRequired["capo_s3.types.account_id.AccountId"]
    """<p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p>"""