Types

The URL of the S3 bucket

The AWS region name for the S3 bucket

The key prefix to use; will be prepended to all key names you pass to S3 functions using this s3bucket.

The access key ID to use for authenticating against the AWS S3 service. Write-only; value cannot be read.

The secret key to use for authenticating against the AWS S3 service. Write-only; value cannot be read.

The session token value to use for authenticating against the AWS S3 service. Write-only; value cannot be read.

The server-side encryption type to use for storing data in S3, if any. Write-only; value cannot be read.

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.

The context valueto use for server-side encryption of data stored in S3, if any. Write-only; value cannot be read.

The object key. If the s3bucket is configured with a keyprefix, the prefix will not be included in this value.

The 'entity tag' - a hash reflecting the content of the object.

The Last-Modified date for the object

The owner of the S3 object

The size of the S3 object, in bytes.

The class of storage being used. Currently known values are STANDARD, STANDARD_IA, GLACIER and RRS.

List of basic information records for a collection of S3 objects, as returned by s3listobjects

List of the 'common prefixes' returned by s3listobjects, if any

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.

The Cache-Control header used in requests for the object

The Content-Disposition header used in requests for the object

The Content-Encoding header used in requests for the object

The Content-Length header used in requests for the object. This value is ignored by the 's3putobject' subroutine.

The Content-Type header used in requests for the object

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.

Boolean value set to 'true' if the object has a configured expiration action. This value is ignored by the 's3putobject' subroutine

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

Flag indicating whether the object was a delete-marker. This value is ignored by the 's3putobject' subroutine

Array of user-defined meta-data fields

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.

Where server-side encryption is enabled, the name of the encryption algorithm used, otherwise an empty string.

Where server-side encryption type 'aws:kms' is used, the ID of the encryption key in the Amazon Key Management Service

The class of storage being used. Currently known values are STANDARD, STANDARD_IA, GLACIER and RRS.

The count of tags associated with the object. This value is ignored by the 's3putobject' subroutine.

If the object has a unique version ID, that version ID, otherwise empty string. This value is ignored by the 's3putobject' subroutine.

The 'entity tag' - a hash reflecting the content of the object. This value is ignored by the 's3putobject' subroutine.

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.