Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface SelectObjectContentCommandInputProtected

Hierarchy

Properties

Bucket: undefined | string

The S3 bucket.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "@aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

ExpectedBucketOwner?: string

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

Expression: undefined | string

The expression that is used to query the object.

ExpressionType: undefined | string

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

InputSerialization: undefined | InputSerialization

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

Key: undefined | string

The object key.

OutputSerialization: undefined | OutputSerialization

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

RequestProgress?: RequestProgress

Specifies if periodic request progress information should be enabled.

SSECustomerAlgorithm?: 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.

SSECustomerKey?: 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.

SSECustomerKeyMD5?: 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.

ScanRange?: 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:

  • 50100 - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

  • 50 - process only the records starting after the byte 50

  • 50 - process only the records within the last 50 bytes of the file.