Class: Aws::S3::Types::SelectObjectContentRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::SelectObjectContentRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-s3/types.rb
Overview
<note markdown=“1”> Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. [Learn more]
</note>
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]: aws.amazon.com/blogs/storage/how-to-optimize-querying-your-data-in-amazon-s3/ [2]: docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectSELECTContent.html
Constant Summary collapse
- SENSITIVE =
[:sse_customer_key]
Instance Attribute Summary collapse
-
#bucket ⇒ String
The S3 bucket.
-
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner.
-
#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 ⇒ Types::InputSerialization
Describes the format of the data in the object that is being queried.
-
#key ⇒ String
The object key.
-
#output_serialization ⇒ Types::OutputSerialization
Describes the format of the data that you want Amazon S3 to return in response.
-
#request_progress ⇒ Types::RequestProgress
Specifies if periodic request progress information should be enabled.
-
#scan_range ⇒ Types::ScanRange
Specifies the byte range of the object to get the records from.
-
#sse_customer_algorithm ⇒ String
The server-side encryption (SSE) algorithm used to encrypt the object.
-
#sse_customer_key ⇒ String
The server-side encryption (SSE) customer managed key.
-
#sse_customer_key_md5 ⇒ String
The MD5 server-side encryption (SSE) customer managed key.
Instance Attribute Details
#bucket ⇒ String
The S3 bucket.
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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_owner ⇒ String
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).
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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 ⇒ String
The expression that is used to query the object.
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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_type ⇒ String
The type of the provided expression (for example, SQL).
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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_serialization ⇒ Types::InputSerialization
Describes the format of the data in the object that is being queried.
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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 |
#key ⇒ String
The object key.
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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_serialization ⇒ Types::OutputSerialization
Describes the format of the data that you want Amazon S3 to return in response.
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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_progress ⇒ Types::RequestProgress
Specifies if periodic request progress information should be enabled.
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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_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.
‘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.
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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_algorithm ⇒ String
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
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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 ⇒ String
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
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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_md5 ⇒ String
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
17237 17238 17239 17240 17241 17242 17243 17244 17245 17246 17247 17248 17249 17250 17251 17252 |
# File 'lib/aws-sdk-s3/types.rb', line 17237 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 |