@aws-sdk/client-s3

import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; import { SelectObjectContentOutput, SelectObjectContentRequest } from "../models/models_1"; import { deserializeAws_restXmlSelectObjectContentCommand, serializeAws_restXmlSelectObjectContentCommand, } from "../protocols/Aws_restXml"; import { getBucketEndpointPlugin } from "@aws-sdk/middleware-bucket-endpoint"; import { getSerdePlugin } from "@aws-sdk/middleware-serde"; import { getSsecPlugin } from "@aws-sdk/middleware-ssec"; import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { FinalizeHandlerArguments, Handler, HandlerExecutionContext, MiddlewareStack, EventStreamSerdeContext as __EventStreamSerdeContext, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, SerdeContext as __SerdeContext, } from "@aws-sdk/types"; export type SelectObjectContentCommandInput = SelectObjectContentRequest; export type SelectObjectContentCommandOutput = SelectObjectContentOutput & __MetadataBearer; /** * This operation 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 action is not supported by Amazon S3 on Outposts. * For more information about Amazon S3 Select, * see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html">Selecting Content from * Objects</a> in the Amazon Simple Storage Service Developer Guide. * For more information about using SQL with Amazon S3 Select, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html"> SQL Reference for Amazon S3 Select * and S3 Glacier Select</a> in the Amazon Simple Storage Service Developer Guide. * * * Permissions * * You must have <code>s3:GetObject</code> permission for this operation. Amazon S3 Select does * not support anonymous access. For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html">Specifying Permissions in a Policy</a> * in the Amazon Simple Storage Service Developer Guide. * * * Object Data Formats * * You can use Amazon S3 Select to query objects that have the following format * properties: * <ul> * <li> * * CSV, JSON, and Parquet - Objects must be in CSV, JSON, or * Parquet format. * </li> * <li> * * UTF-8 - UTF-8 is the only encoding type Amazon S3 Select * supports. * </li> * <li> * * 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. * </li> * <li> * * 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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. For more information about SSE-C, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html">Server-Side Encryption * (Using Customer-Provided Encryption Keys)</a> in the * Amazon Simple Storage Service Developer Guide. * For objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and * customer master keys (CMKs) stored in AWS Key Management Service (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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html">Protecting Data Using * Server-Side Encryption</a> in the Amazon Simple Storage Service Developer Guide. * </li> * </ul> * * * 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 <code>Transfer-Encoding</code> header with <code>chunked</code> as * its value in the response. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html">Appendix: SelectObjectContent * Response</a> * . * * * * GetObject Support * * The <code>SelectObjectContent</code> operation does not support the following * <code>GetObject</code> functionality. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a>. * <ul> * <li> * * <code>Range</code>: Although you can specify a scan range for an Amazon S3 Select request * (see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange">SelectObjectContentRequest - ScanRange</a> in the request parameters), * you cannot specify the range of bytes of an object to return. * </li> * <li> * GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify * the GLACIER, DEEP_ARCHIVE, or <code>REDUCED_REDUNDANCY</code> storage classes. For * more information, about storage classes see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro">Storage Classes</a> * in the Amazon Simple Storage Service Developer Guide. * </li> * </ul> * * * Special Errors * * * For a list of special errors for this operation, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList">List of * SELECT Object Content Error Codes</a> * * * Related Resources * * <ul> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html">GetObject</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html">PutBucketLifecycleConfiguration</a> * * </li> * </ul> */ export class SelectObjectContentCommand extends $Command< SelectObjectContentCommandInput, SelectObjectContentCommandOutput, S3ClientResolvedConfig > { // Start section: command_properties // End section: command_properties constructor(readonly input: SelectObjectContentCommandInput) { // Start section: command_constructor super(); // End section: command_constructor } /** * @internal */ resolveMiddleware( clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions ): Handler<SelectObjectContentCommandInput, SelectObjectContentCommandOutput> { this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize)); this.middlewareStack.use(getSsecPlugin(configuration)); this.middlewareStack.use(getBucketEndpointPlugin(configuration)); const stack = clientStack.concat(this.middlewareStack); const { logger } = configuration; const clientName = "S3Client"; const commandName = "SelectObjectContentCommand"; const handlerExecutionContext: HandlerExecutionContext = { logger, clientName, commandName, inputFilterSensitiveLog: SelectObjectContentRequest.filterSensitiveLog, outputFilterSensitiveLog: SelectObjectContentOutput.filterSensitiveLog, }; const { requestHandler } = configuration; return stack.resolve( (request: FinalizeHandlerArguments<any>) => requestHandler.handle(request.request as __HttpRequest, options || {}), handlerExecutionContext ); } private serialize(input: SelectObjectContentCommandInput, context: __SerdeContext): Promise<__HttpRequest> { return serializeAws_restXmlSelectObjectContentCommand(input, context); } private deserialize( output: __HttpResponse, context: __SerdeContext & __EventStreamSerdeContext ): Promise<SelectObjectContentCommandOutput> { return deserializeAws_restXmlSelectObjectContentCommand(output, context); } // Start section: command_body_extra // End section: command_body_extra }