AWSS3SelectObjectContentRequest

Objective-C

@interface AWSS3SelectObjectContentRequest

Swift

class AWSS3SelectObjectContentRequest

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.

Required parameters: [Bucket, Key, Expression, ExpressionType, InputSerialization, OutputSerialization]

  • The S3 bucket.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable bucket;

    Swift

    var bucket: String? { get set }

  • The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable expectedBucketOwner;

    Swift

    var expectedBucketOwner: String? { get set }

  • The expression that is used to query the object.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable expression;

    Swift

    var expression: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ExpressionType expressionType;

    Swift

    var expressionType: AWSS3ExpressionType { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3InputSerialization *_Nullable inputSerialization;

    Swift

    var inputSerialization: AWSS3InputSerialization? { get set }
  • key

    The object key.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable key;

    Swift

    var key: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3OutputSerialization *_Nullable outputSerialization;

    Swift

    var outputSerialization: AWSS3OutputSerialization? { get set }

  • Specifies if periodic request progress information should be enabled.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3RequestProgress *_Nullable requestProgress;

    Swift

    var requestProgress: AWSS3RequestProgress? { get set }

  • The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSECustomerAlgorithm;

    Swift

    var sseCustomerAlgorithm: String? { get set }

  • The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSECustomerKey;

    Swift

    var sseCustomerKey: String? { get set }

  • The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable SSECustomerKeyMD5;

    Swift

    var sseCustomerKeyMD5: String? { get set }

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

    • <scanrange><start>50</start><end>100</end></scanrange> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

    • <scanrange><start>50</start></scanrange> - process only the records starting after the byte 50

    • <scanrange><end>50</end></scanrange> - process only the records within the last 50 bytes of the file.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3ScanRange *_Nullable scanRange;

    Swift

    var scanRange: AWSS3ScanRange? { get set }