IBM COS SDK for JavaScript V2 - v1.0.0
    Preparing search index...

    Interface SelectObjectContentRequest

    Learn Amazon S3 Select is no longer available to new customers. Existing customers of Amazon S3 Select can continue to use the feature as usual. Learn more

    Request to filter 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 specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.

    interface SelectObjectContentRequest {
        Bucket: string | undefined;
        Key: string | undefined;
        SSECustomerAlgorithm?: string;
        SSECustomerKey?: string;
        SSECustomerKeyMD5?: string;
        Expression: string | undefined;
        ExpressionType: "SQL" | undefined;
        RequestProgress?: RequestProgress;
        InputSerialization: InputSerialization | undefined;
        OutputSerialization: OutputSerialization | undefined;
        ScanRange?: ScanRange;
        ExpectedBucketOwner?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Bucket Key SSECustomerAlgorithm? SSECustomerKey? SSECustomerKeyMD5? Expression ExpressionType RequestProgress? InputSerialization OutputSerialization ScanRange? ExpectedBucketOwner?

    Properties

    Bucket: string | undefined

    The S3 bucket.

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

    Key: string | undefined

    The object key.

    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.

    Expression: string | undefined

    The expression that is used to query the object.

    ExpressionType: "SQL" | undefined

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

    RequestProgress?: RequestProgress

    Specifies if periodic request progress information should be enabled.

    InputSerialization: InputSerialization | undefined

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

    OutputSerialization: OutputSerialization | undefined

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

    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.

    ExpectedBucketOwner?: 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).

    Settings

    Member Visibility

    On This Page

    Properties