Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SelectObjectContentCommandInput

Hierarchy

Index

Properties

Bucket

Bucket: string | undefined

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

Optional ExpectedBucketOwner

ExpectedBucketOwner: undefined | 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

Expression: string | undefined

The expression that is used to query the object.

ExpressionType

ExpressionType: ExpressionType | string | undefined

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

InputSerialization

InputSerialization: InputSerialization | undefined

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

Key

Key: string | undefined

The object key.

OutputSerialization

OutputSerialization: OutputSerialization | undefined

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

Optional RequestProgress

RequestProgress: RequestProgress

Specifies if periodic request progress information should be enabled.

Optional SSECustomerAlgorithm

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

Optional SSECustomerKey

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

Optional SSECustomerKeyMD5

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

Optional ScanRange

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.