You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::SelectObjectContentRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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 also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, go to S3Select API Documentation.

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The S3 Bucket.

Returns:

  • (String)

    The S3 Bucket.

#expressionString

The expression that is used to query the object.

Returns:

  • (String)

    The expression that is used to query the object.

#expression_typeString

The type of the provided expression (e.g., SQL).

Possible values:

  • SQL

Returns:

  • (String)

    The type of the provided expression (e.g., SQL).

#input_serializationTypes::InputSerialization

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

Returns:

#keyString

The Object Key.

Returns:

  • (String)

    The Object Key.

#output_serializationTypes::OutputSerialization

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

Returns:

#request_progressTypes::RequestProgress

Specifies if periodic request progress information should be enabled.

Returns:

#sse_customer_algorithmString

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

Returns:

  • (String)

    The SSE Algorithm used to encrypt the object.

#sse_customer_keyString

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

Returns:

  • (String)

    The SSE Customer Key.

#sse_customer_key_md5String

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

Returns:

  • (String)

    The SSE Customer Key MD5.