Initializing help system before first use

# s3getobject

Purpose
Copies an object from the S3 bucket to a local Mosel file.
Synopsis
`procedure s3getobject(bucket:s3bucket, objectkey:text, dstfname:text, dstobjectmetadata:s3objectmetadata)`
`procedure s3getobject(bucket:s3bucket, objectkey:text, dstfname:text)`
Arguments

bucket | The s3bucket object describing the bucket to access
objectkey | The key of the object to retrieve
dstfname | Filename into which to download the object, e.g. "myfile.dat" or "mmsystem.text:filedata"
dstobjectmetadata | Record into which the object meta-data is copied

Example

    declarations
      myfilecontent: text
    end-declarations
    s3getobject(mybucket,"my/file.dat","mmsystem.text:myfilecontent")
    if s3status(mybucket)<>S3_OK then
      writeln("Error returned by S3: ",s3getlasterror(mybucket))
      exit(1)
    end-if
    writeln("Fetched data: ",myfilecontent)

Further information
1. After calling, check the value of s3status for any errors.
2. The procedure will not return until the object has been downloaded or an error detected.
3. If the s3bucket has a configured keyprefix, it will be prepended to the objectkey passed in.
Related topics
s3status s3putobject s3objectmetadata
Parent Topic Subroutines

© 2001-2026 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.