Struct aws_sdk_s3::operation::select_object_content::builders::SelectObjectContentFluentBuilder
source · pub struct SelectObjectContentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SelectObjectContent
.
This operation is not supported by directory buckets.
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.
This functionality is not supported for Amazon S3 on Outposts.
For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.
- Permissions
-
You must have the
s3:GetObject
permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide. - Object Data Formats
-
You can use Amazon S3 Select to query objects that have the following format properties:
-
CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.
-
UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.
-
GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.
-
Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.
For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.
For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don't need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.
-
- Working with the Response Body
-
Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a
Transfer-Encoding
header withchunked
as its value in the response. For more information, see Appendix: SelectObjectContent Response. - GetObject Support
-
The
SelectObjectContent
action does not support the followingGetObject
functionality. For more information, see GetObject.-
Range
: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return. -
The
GLACIER
,DEEP_ARCHIVE
, andREDUCED_REDUNDANCY
storage classes, or theARCHIVE_ACCESS
andDEEP_ARCHIVE_ACCESS
access tiers of theINTELLIGENT_TIERING
storage class: You cannot query objects in theGLACIER
,DEEP_ARCHIVE
, orREDUCED_REDUNDANCY
storage classes, nor objects in theARCHIVE_ACCESS
orDEEP_ARCHIVE_ACCESS
access tiers of theINTELLIGENT_TIERING
storage class. For more information about storage classes, see Using Amazon S3 storage classes in the Amazon S3 User Guide.
-
- Special Errors
-
For a list of special errors for this operation, see List of SELECT Object Content Error Codes
The following operations are related to SelectObjectContent
:
Implementations§
source§impl SelectObjectContentFluentBuilder
impl SelectObjectContentFluentBuilder
sourcepub fn as_input(&self) -> &SelectObjectContentInputBuilder
pub fn as_input(&self) -> &SelectObjectContentInputBuilder
Access the SelectObjectContent as a reference.
sourcepub async fn send(
self,
) -> Result<SelectObjectContentOutput, SdkError<SelectObjectContentError, HttpResponse>>
pub async fn send( self, ) -> Result<SelectObjectContentOutput, SdkError<SelectObjectContentError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self,
) -> CustomizableOperation<SelectObjectContentOutput, SelectObjectContentError, Self>
pub fn customize( self, ) -> CustomizableOperation<SelectObjectContentOutput, SelectObjectContentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
The S3 bucket.
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The S3 bucket.
sourcepub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
pub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
pub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
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.
sourcepub fn get_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_sse_customer_algorithm(&self) -> &Option<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.
sourcepub fn sse_customer_key(self, input: impl Into<String>) -> Self
pub fn sse_customer_key(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_sse_customer_key(self, input: Option<String>) -> Self
pub fn set_sse_customer_key(self, input: Option<String>) -> Self
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.
sourcepub fn get_sse_customer_key(&self) -> &Option<String>
pub fn get_sse_customer_key(&self) -> &Option<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.
sourcepub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
pub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
pub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
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.
sourcepub fn get_sse_customer_key_md5(&self) -> &Option<String>
pub fn get_sse_customer_key_md5(&self) -> &Option<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.
sourcepub fn expression(self, input: impl Into<String>) -> Self
pub fn expression(self, input: impl Into<String>) -> Self
The expression that is used to query the object.
sourcepub fn set_expression(self, input: Option<String>) -> Self
pub fn set_expression(self, input: Option<String>) -> Self
The expression that is used to query the object.
sourcepub fn get_expression(&self) -> &Option<String>
pub fn get_expression(&self) -> &Option<String>
The expression that is used to query the object.
sourcepub fn expression_type(self, input: ExpressionType) -> Self
pub fn expression_type(self, input: ExpressionType) -> Self
The type of the provided expression (for example, SQL).
sourcepub fn set_expression_type(self, input: Option<ExpressionType>) -> Self
pub fn set_expression_type(self, input: Option<ExpressionType>) -> Self
The type of the provided expression (for example, SQL).
sourcepub fn get_expression_type(&self) -> &Option<ExpressionType>
pub fn get_expression_type(&self) -> &Option<ExpressionType>
The type of the provided expression (for example, SQL).
sourcepub fn request_progress(self, input: RequestProgress) -> Self
pub fn request_progress(self, input: RequestProgress) -> Self
Specifies if periodic request progress information should be enabled.
sourcepub fn set_request_progress(self, input: Option<RequestProgress>) -> Self
pub fn set_request_progress(self, input: Option<RequestProgress>) -> Self
Specifies if periodic request progress information should be enabled.
sourcepub fn get_request_progress(&self) -> &Option<RequestProgress>
pub fn get_request_progress(&self) -> &Option<RequestProgress>
Specifies if periodic request progress information should be enabled.
sourcepub fn input_serialization(self, input: InputSerialization) -> Self
pub fn input_serialization(self, input: InputSerialization) -> Self
Describes the format of the data in the object that is being queried.
sourcepub fn set_input_serialization(self, input: Option<InputSerialization>) -> Self
pub fn set_input_serialization(self, input: Option<InputSerialization>) -> Self
Describes the format of the data in the object that is being queried.
sourcepub fn get_input_serialization(&self) -> &Option<InputSerialization>
pub fn get_input_serialization(&self) -> &Option<InputSerialization>
Describes the format of the data in the object that is being queried.
sourcepub fn output_serialization(self, input: OutputSerialization) -> Self
pub fn output_serialization(self, input: OutputSerialization) -> Self
Describes the format of the data that you want Amazon S3 to return in response.
sourcepub fn set_output_serialization(
self,
input: Option<OutputSerialization>,
) -> Self
pub fn set_output_serialization( self, input: Option<OutputSerialization>, ) -> Self
Describes the format of the data that you want Amazon S3 to return in response.
sourcepub fn get_output_serialization(&self) -> &Option<OutputSerialization>
pub fn get_output_serialization(&self) -> &Option<OutputSerialization>
Describes the format of the data that you want Amazon S3 to return in response.
sourcepub fn scan_range(self, input: ScanRange) -> Self
pub fn scan_range(self, input: ScanRange) -> Self
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:
-
- process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)50 100 -
- process only the records starting after the byte 5050 -
- process only the records within the last 50 bytes of the file.50
sourcepub fn set_scan_range(self, input: Option<ScanRange>) -> Self
pub fn set_scan_range(self, input: Option<ScanRange>) -> Self
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:
-
- process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)50 100 -
- process only the records starting after the byte 5050 -
- process only the records within the last 50 bytes of the file.50
sourcepub fn get_scan_range(&self) -> &Option<ScanRange>
pub fn get_scan_range(&self) -> &Option<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:
-
- process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)50 100 -
- process only the records starting after the byte 5050 -
- process only the records within the last 50 bytes of the file.50
sourcepub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
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).
sourcepub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
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).
sourcepub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<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).
Trait Implementations§
source§impl Clone for SelectObjectContentFluentBuilder
impl Clone for SelectObjectContentFluentBuilder
source§fn clone(&self) -> SelectObjectContentFluentBuilder
fn clone(&self) -> SelectObjectContentFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for SelectObjectContentFluentBuilder
impl !RefUnwindSafe for SelectObjectContentFluentBuilder
impl Send for SelectObjectContentFluentBuilder
impl Sync for SelectObjectContentFluentBuilder
impl Unpin for SelectObjectContentFluentBuilder
impl !UnwindSafe for SelectObjectContentFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)