Struct: s3.SelectObjectContentInput

import "../ibm-cos-sdk-go-v2/service/s3"

Overview

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.

Implemented Interfaces

types.AnalyticsFilter, v4.HTTPPresigner, s3.HTTPPresignerV4, types.MetricsFilter, s3.PresignPost, arn.S3ObjectLambdaARN, types.SelectObjectContentEventStream

Structure Field Summary collapse

Structure Field Details

Bucket *string

The S3 bucket.

This member is required.

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

Expression *string

The expression that is used to query the object.

This member is required.

ExpressionType types.ExpressionType

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

This member is required.

InputSerialization *types.InputSerialization

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

This member is required.

Key *string

The object key.

This member is required.

OutputSerialization *types.OutputSerialization

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

This member is required.

RequestProgress *types.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 data using SSE-C keys[https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html]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 data using SSE-C keys[https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html]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 data using SSE-C keys[https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html]in the Amazon S3 User Guide.

ScanRange *types.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:

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