interface

S3ListObjectsOptions

interface S3ListObjectsOptions

  • continuationToken?: string

    Indicates that the listing is being continued on this bucket with a token from a previous response. The token is obfuscated and is not a real key. Use it to paginate the list results.

  • delimiter?: string

    A delimiter is a character that you use to group keys.

  • encodingType?: 'url'

    Encoding type used by S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character, but the XML 1.0 parser can't parse some characters, such as those with an ASCII value from 0 to 10. For those keys, set this parameter to ask S3 to encode the keys in the response.

  • fetchOwner?: boolean

    Set to true to include the owner field with each key in the result.

  • maxKeys?: number

    The maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but never contains more.

  • prefix?: string

    Limits the response to keys that begin with the specified prefix.

  • startAfter?: string

    S3 starts listing after this key. It can be any key in the bucket.