Skip to main content

S3.list_objects

S3.list_objectsbucket prefixcredentialsmax_count

Documentation​

Gets the list of the items inside a bucket.

Arguments​

  • bucket: the name of the bucket.
  • prefix: the prefix of keys to match.
  • max_count: the maximum number of items to return. The default is 1000.
  • credentials: The credentials to use to access the S3 bucket. If not specified, the default credentials are used.

Returns​

  • A vector of object keys (as Text) (including the prefix).

Errors​

  • If the credentials are invalid or access to S3 is denied, then an AWS_SDK_Error will be raised.
  • If the bucket does not exist, an S3_Bucket_Not_Found error is thrown.
  • If more items are available than the max_count parameter, a More_Records_Available warning is attached to the result.