Struct aws_sdk_s3::input::SelectObjectContentInput

#[non_exhaustive]
pub struct SelectObjectContentInput { /* private fields */ }

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.

Implementations

impl SelectObjectContentInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<SelectObjectContent, AwsResponseRetryClassifier>, BuildError>

Consumes the builder and constructs an Operation<SelectObjectContent>

Examples found in repository

src/client.rs (line 15434)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::SelectObjectContent,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::SelectObjectContentError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::SelectObjectContentOutput,
            aws_smithy_http::result::SdkError<crate::error::SelectObjectContentError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SelectObjectContentInput.

impl SelectObjectContentInput

pub fn bucket(&self) -> Option<&str>

The S3 bucket.

pub fn key(&self) -> Option<&str>

The object key.

pub fn sse_customer_algorithm(&self) -> Option<&str>

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 Protecting data using SSE-C keys in the Amazon S3 User Guide.

pub fn sse_customer_key(&self) -> Option<&str>

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 Protecting data using SSE-C keys in the Amazon S3 User Guide.

pub fn sse_customer_key_md5(&self) -> Option<&str>

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 Protecting data using SSE-C keys in the Amazon S3 User Guide.

pub fn expression(&self) -> Option<&str>

The expression that is used to query the object.

pub fn expression_type(&self) -> Option<&ExpressionType>

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

pub fn request_progress(&self) -> Option<&RequestProgress>

Specifies if periodic request progress information should be enabled.

pub fn input_serialization(&self) -> Option<&InputSerialization>

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

pub fn output_serialization(&self) -> Option<&OutputSerialization>

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

pub fn scan_range(&self) -> 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:

• 50 100 - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

• 50 - process only the records starting after the byte 50

• 50 - process only the records within the last 50 bytes of the file.

pub fn expected_bucket_owner(&self) -> Option<&str>

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

Trait Implementations

impl Clone for SelectObjectContentInput

fn clone(&self) -> SelectObjectContentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SelectObjectContentInput

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

Formats the value using the given formatter.

impl PartialEq<SelectObjectContentInput> for SelectObjectContentInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SelectObjectContentInput