s3_select_object_content: This action filters the contents of an Amazon S3 object based...

In paws.storage: 'Amazon Web Services' Storage Services

This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement

Description

This action filters 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 also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

See https://www.paws-r-sdk.com/docs/s3_select_object_content/ for full documentation.

Usage

s3_select_object_content(
  Bucket,
  Key,
  SSECustomerAlgorithm = NULL,
  SSECustomerKey = NULL,
  SSECustomerKeyMD5 = NULL,
  Expression,
  ExpressionType,
  RequestProgress = NULL,
  InputSerialization,
  OutputSerialization,
  ScanRange = NULL,
  ExpectedBucketOwner = NULL
)

Arguments

Bucket	[required] The S3 bucket.
Key	[required] The object key.
SSECustomerAlgorithm	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.
SSECustomerKey	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.
SSECustomerKeyMD5	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.
Expression	[required] The expression that is used to query the object.
ExpressionType	[required] The type of the provided expression (for example, SQL).
RequestProgress	Specifies if periodic request progress information should be enabled.
InputSerialization	[required] Describes the format of the data in the object that is being queried.
OutputSerialization	[required] Describes the format of the data that you want Amazon S3 to return in response.
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.
ExpectedBucketOwner	The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code ⁠403 Forbidden⁠ (access denied).

paws.storage documentation built on Sept. 12, 2023, 1:23 a.m.