Initializing help system before first use

Types

s3bucket  : type
Represents an S3 bucket, including bucket URL, key prefix, login credentials and error state.
url  : text
The URL of the S3 bucket
region  : text
The AWS region name for the S3 bucket
keyprefix  : text
The key prefix to use; will be prepended to all key names you pass to S3 functions using this s3bucket.
accesskeyid  : text
The access key ID to use for authenticating against the AWS S3 service. Write-only; value cannot be read.
secretkey  : text
The secret key to use for authenticating against the AWS S3 service. Write-only; value cannot be read.
sessiontoken  : text
The session token value to use for authenticating against the AWS S3 service. Write-only; value cannot be read.
sse  : text
The server-side encryption type to use for storing data in S3, if any. Write-only; value cannot be read.
ssekmskeyid  : text
The ID of the AWS KMS key to use for server-side encryption of data stored in S3, if any. Write-only; value cannot be read.
ssecontext  : text
The context valueto use for server-side encryption of data stored in S3, if any. Write-only; value cannot be read.
refreshfunc  : function(s3bucket):boolean
A function pointer that will be called to update the S3 bucket properties when more than ttl seconds have elapsed since timestamp. The function should update the required properties of the s3bucket, including timestamp, and return true on success or false on error. Optional.
timestamp  : real
The timestamp at which the credentials were generated, expressed in seconds since 1/1/1970.
ttl  : integer
The number of seconds for which the bucket credentials will remain valid.
s3objectinfo  : record
Record type representing basic information about an S3 object
key  : text
The object key. If the s3bucket is configured with a keyprefix, the prefix will not be included in this value.
etag  : text
The 'entity tag' - a hash reflecting the content of the object.
lastmodified  : datetime
The Last-Modified date for the object
owner  : s3owner
The owner of the S3 object
size  : real
The size of the S3 object, in bytes.
storageclass  : text
The class of storage being used. Currently known values are STANDARD, STANDARD_IA, GLACIER and RRS.
s3objectlist  : record
Record type representing a list of S3 objects.
objects  : list of s3objectinfo
List of basic information records for a collection of S3 objects, as returned by s3listobjects
commonprefixes  : list of text
List of the 'common prefixes' returned by s3listobjects, if any
istruncated  : boolean
Flag indicating whether the list of objects has been truncated. If true, you should call 's3listobjects' again, passing the same arguments and s3objectlist record structure, after processing the data in the 'objects' and 'commonprefixes' fields.
s3objectmetadata  : record
Record type representing object meta-data for an S3 object
cachecontrol  : text
The Cache-Control header used in requests for the object
contentdisposition  : text
The Content-Disposition header used in requests for the object
contentencoding  : text
The Content-Encoding header used in requests for the object
contentlength  : real
The Content-Length header used in requests for the object. This value is ignored by the 's3putobject' subroutine.
contenttype  : text
The Content-Type header used in requests for the object
lastmodified  : text
The Last-Modified date for the object, in text format as returned by the server, e.g. "Wed, 12 Oct 2009 17:50:00 GMT". This value is ignored by the 's3putobject' subroutine.
expiration  : boolean
Boolean value set to 'true' if the object has a configured expiration action. This value is ignored by the 's3putobject' subroutine
expirationdetails  : text
If the expiration field is 'true', the text content of the 'expiration' header. This includes an 'expiry-date' component and a URL-encoded 'rule-id' component. This value is ignored by the 's3putobject' subroutine
deletemarker  : boolean
Flag indicating whether the object was a delete-marker. This value is ignored by the 's3putobject' subroutine
usermetadata  : array(s3usermetadatakeys) of text
Array of user-defined meta-data fields
replicationstatus  : string
Replication status, if the object is in a bucket which is the source or destination of a cross-region replication. When the object is in the source bucket, this will be PENDING, COMPLETED or FAILED. When the object is in the destination bucket, this will be REPLICA if the object is a replica created by Amazon S3. When the object is not in a replication bucket, this will be an empty string. This value is ignored by the 's3putobject' subroutine.
serversideencryption  : text
Where server-side encryption is enabled, the name of the encryption algorithm used, otherwise an empty string.
ssekmskeyid  : text
Where server-side encryption type 'aws:kms' is used, the ID of the encryption key in the Amazon Key Management Service
storageclass  : string
The class of storage being used. Currently known values are STANDARD, STANDARD_IA, GLACIER and RRS.
taggingcount  : integer
The count of tags associated with the object. This value is ignored by the 's3putobject' subroutine.
versionid  : text
If the object has a unique version ID, that version ID, otherwise empty string. This value is ignored by the 's3putobject' subroutine.
etag  : text
The 'entity tag' - a hash reflecting the content of the object. This value is ignored by the 's3putobject' subroutine.
websiteredirect  : text
When bucket is configured as a website, this metadata will evaluate the request as a 301 redirect to another object in the same bucket, or an external URL.
s3owner  : record
Record type representing information about the owner of an S3 object
id  : text
displayname  : text
s3tag  : record
Record type representing a single S3 object tag.
key  : string
value  : text

Parent Topic Amazon S3 Module

© 2001-2025 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.