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 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The S3 bucket.

Returns:

  • (String) —

    The S3 bucket.

#expected_bucket_owner ⇒ 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.

Returns:

  • (String) —

    The account id of the expected bucket owner.

#expression ⇒ String

The expression that is used to query the object.

Returns:

  • (String) —

    The expression that is used to query the object.

#expression_type ⇒ String

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

Possible values:

  • SQL

Returns:

  • (String) —

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

#input_serialization ⇒ Types::InputSerialization

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

Returns:

#key ⇒ String

The object key.

Returns:

  • (String) —

    The object key.

#output_serialization ⇒ Types::OutputSerialization

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

Returns:

#request_progress ⇒ Types::RequestProgress

Specifies if periodic request progress information should be enabled.

Returns:

#scan_range ⇒ Types::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.

Returns:

  • (Types::ScanRange) —

    Specifies the byte range of the object to get the records from.

#sse_customer_algorithm ⇒ String

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

Returns:

  • (String) —

    The SSE Algorithm used to encrypt the object.

#sse_customer_key ⇒ String

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

Returns:

  • (String) —

    The SSE Customer Key.

#sse_customer_key_md5 ⇒ String

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

Returns:

  • (String) —

    The SSE Customer Key MD5.