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

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

Overview

Note:

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",
    },
  },
}

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The S3 bucket.

Returns:

  • (String) 


9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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)
  include Aws::Structure
end

#expression ⇒ String

The expression that is used to query the object.

Returns:

  • (String) 


9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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)
  include Aws::Structure
end

#expression_type ⇒ String

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

Returns:

  • (String) 


9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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)
  include Aws::Structure
end

#input_serialization ⇒ Types::InputSerialization

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

Returns:



9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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)
  include Aws::Structure
end

#key ⇒ String

The object key.

Returns:

  • (String) 


9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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)
  include Aws::Structure
end

#output_serialization ⇒ Types::OutputSerialization

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

Returns:



9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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)
  include Aws::Structure
end

#request_progress ⇒ Types::RequestProgress

Specifies if periodic request progress information should be enabled.

Returns:



9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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

Returns:

  • (String) 


9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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

Returns:

  • (String) 


9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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

Returns:

  • (String) 


9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
 
# File 'lib/aws-sdk-s3/types.rb', line 9216

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)
  include Aws::Structure
end