Struct rusoto_s3::SelectObjectContentRequest

pub struct SelectObjectContentRequest {
    pub bucket: String,
    pub expected_bucket_owner: Option<String>,
    pub expression: String,
    pub expression_type: String,
    pub input_serialization: InputSerialization,
    pub key: String,
    pub output_serialization: OutputSerialization,
    pub request_progress: Option<RequestProgress>,
    pub sse_customer_algorithm: Option<String>,
    pub sse_customer_key: Option<String>,
    pub sse_customer_key_md5: Option<String>,
    pub scan_range: Option<ScanRange>,
}

Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.

Fields

bucket: String

The S3 bucket.

expected_bucket_owner: Option<String>

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

expression: String

The expression that is used to query the object.

expression_type: String

The type of the provided expression (for example, SQL).

input_serialization: InputSerialization

Describes the format of the data in the object that is being queried.

key: String

The object key.

output_serialization: OutputSerialization

Describes the format of the data that you want Amazon S3 to return in response.

request_progress: Option<RequestProgress>

Specifies if periodic request progress information should be enabled.

sse_customer_algorithm: Option<String>

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

sse_customer_key: Option<String>

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

sse_customer_key_md5: Option<String>

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

scan_range: Option<ScanRange>

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.

ScanRangemay be used in the following ways:

• <scanrange><start>50</start><end>100</end></scanrange> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

• <scanrange><start>50</start></scanrange> - process only the records starting after the byte 50

• <scanrange><end>50</end></scanrange> - process only the records within the last 50 bytes of the file.

Trait Implementations

impl Clone for SelectObjectContentRequest

fn clone(&self) -> SelectObjectContentRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SelectObjectContentRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SelectObjectContentRequest

fn default() -> SelectObjectContentRequest

Returns the “default value” for a type.

impl PartialEq<SelectObjectContentRequest> for SelectObjectContentRequest

fn eq(&self, other: &SelectObjectContentRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SelectObjectContentRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for SelectObjectContentRequest