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
When making an API call, you may pass SelectObjectContentRequest data as a hash:
{
bucket: "BucketName", # required
key: "ObjectKey", # required
sse_customer_algorithm: "SSECustomerAlgorithm",
sse_customer_key: "SSECustomerKey",
sse_customer_key_md5: "SSECustomerKeyMD5",
expression: "Expression", # required
expression_type: "SQL", # required, accepts SQL
request_progress: {
enabled: false,
},
input_serialization: { # required
csv: {
file_header_info: "USE", # accepts USE, IGNORE, NONE
comments: "Comments",
quote_escape_character: "QuoteEscapeCharacter",
record_delimiter: "RecordDelimiter",
field_delimiter: "FieldDelimiter",
quote_character: "QuoteCharacter",
allow_quoted_record_delimiter: false,
},
compression_type: "NONE", # accepts NONE, GZIP, BZIP2
json: {
type: "DOCUMENT", # accepts DOCUMENT, LINES
},
parquet: {
},
},
output_serialization: { # required
csv: {
quote_fields: "ALWAYS", # accepts ALWAYS, ASNEEDED
quote_escape_character: "QuoteEscapeCharacter",
record_delimiter: "RecordDelimiter",
field_delimiter: "FieldDelimiter",
quote_character: "QuoteCharacter",
},
json: {
record_delimiter: "RecordDelimiter",
},
},
scan_range: {
start: 1,
end: 1,
},
}
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
Instance Attribute Summary collapse
-
#bucket ⇒ String
The S3 bucket.
-
#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 SSE Algorithm used to encrypt the object.
-
#sse_customer_key ⇒ String
The SSE Customer Key.
-
#sse_customer_key_md5 ⇒ String
The SSE Customer Key MD5.
Instance Attribute Details
#bucket ⇒ String
The S3 bucket.
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#expression ⇒ String
The expression that is used to query the object.
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#expression_type ⇒ String
The type of the provided expression (for example., SQL).
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#input_serialization ⇒ Types::InputSerialization
Describes the format of the data in the object that is being queried.
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#key ⇒ String
The object key.
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#output_serialization ⇒ Types::OutputSerialization
Describes the format of the data that you want Amazon S3 to return in response.
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#request_progress ⇒ Types::RequestProgress
Specifies if periodic request progress information should be enabled.
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) 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.
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#sse_customer_algorithm ⇒ String
The SSE Algorithm used to encrypt the object. For more information, see [ Server-Side Encryption (Using Customer-Provided Encryption Keys].
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#sse_customer_key ⇒ String
The SSE Customer Key. For more information, see [ Server-Side Encryption (Using Customer-Provided Encryption Keys].
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |
#sse_customer_key_md5 ⇒ String
The SSE Customer Key MD5. For more information, see [ Server-Side Encryption (Using Customer-Provided Encryption Keys].
[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html
9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 |
# File 'lib/aws-sdk-s3/types.rb', line 9416 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) include Aws::Structure end |