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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

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

[1]: docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html

Constant Summary collapse

SENSITIVE =
[:sse_customer_key]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

The S3 bucket.

Returns:

  • (String)


15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#expected_bucket_ownerString

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 ‘403 Forbidden` (access denied).

Returns:

  • (String)


15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#expressionString

The expression that is used to query the object.

Returns:

  • (String)


15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#expression_typeString

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

Returns:

  • (String)


15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#input_serializationTypes::InputSerialization

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



15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#keyString

The object key.

Returns:

  • (String)


15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#output_serializationTypes::OutputSerialization

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



15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#request_progressTypes::RequestProgress

Specifies if periodic request progress information should be enabled.



15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#scan_rangeTypes::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.

‘ScanRange`may 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:



15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_algorithmString

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

Returns:

  • (String)


15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_keyString

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

Returns:

  • (String)


15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_key_md5String

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html

Returns:

  • (String)


15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
# File 'lib/aws-sdk-s3/types.rb', line 15726

class SelectObjectContentRequest < Struct.new(
  :bucket,
  :key,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :expression,
  :expression_type,
  :request_progress,
  :input_serialization,
  :output_serialization,
  :scan_range,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end