AmazonS3 Class

Properties Methods Events Configuration Settings Errors

The S3 Component provides an easy interface to Amazon's Simple Storage Service (S3).

Syntax

incloudstorage.amazons3()

Remarks

The S3 Class allows you to access Amazon's Simple Storage Service (S3) in a secure manner using TLS/SSL. S3 allows you to store arbitrary data objects on Amazon's server and access them from anywhere using an Internet connection. There are features available to authenticate access to private objects, share objects as public, distribute an object using Bittorrent etc. A brief synopsis follows but please refer to Amazon S3 documentation for details.

You will first need to sign up for the S3 service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating buckets in your account using CreateBucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using CreateObject.

There are other methods such as ListBuckets, ListObjects, GetObject, GetLink, DeleteObject etc. that further enable you to manage your S3 data store.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


AccessKey	The Access Key Id for the Amazon Web Services account.
AccessPolicy	The AccessPolicy are used to set permissions when a Bucket or an object is updated.
Bucket	The name of the current bucket.
BucketsCount	The number of records in the Buckets arrays.
BucketsCreationDate	The creation date of the current bucket.
BucketsName	The name of the current bucket.
BucketsOwnerDisplayName	The display name of the current bucket's owner.
BucketsOwnerId	The owner of the current bucket.
Connected	Shows whether the component is connected.
ContentDisposition	Content disposition for the object.
ContentType	Content type for the object.
EncryptionAlgorithm	The encryption algorithm.
EncryptionPassword	The password to use when encrypting the object.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirects	Determines what happens when the server issues a redirect.
Idle	The current status of the component.
LocalFile	The path to a local file for uploading or downloading. When downloading, if the file exists it is overwritten (optional).
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
ObjectData	The contents of the object returned after calling GetObject , or the data to upload.
ObjectDelimiter	A delimiter can be used to organize multiple objects.
ObjectMarker	A marker for the object(s).
ObjectPrefix	A prefix for the object(s).
ObjectsCount	The number of records in the Objects arrays.
ObjectsETag	An Etag for the current object.
ObjectsLastModified	The date and time at which the object was last modified.
ObjectsName	The name (key) of the current object.
ObjectsOwnerDisplayName	The display name of the Object owner.
ObjectsOwnerId	The owner ID of the Object.
ObjectsSize	The size of the current object.
ObjectsStorageClass	The storage type of the current object.
ObjectsUploadId	The Update ID that identifies the multipart upload.
OtherHeaders	Other headers as determined by the user (optional).
Overwrite	Whether or not the component should overwrite files during transfer.
ParsedHeaderCount	The number of records in the ParsedHeader arrays.
ParsedHeaderField	This property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValue	This property contains the header contents.
PartsCount	The number of records in the Parts arrays.
PartsETag	An Etag for the current part.
PartsLastModified	The date and time at which the part was last modified.
PartsObjectName	The name (key) of the current object.
PartsOwnerDisplayName	The display name of the Object owner.
PartsOwnerId	The owner ID of the part.
PartsNumber	The part number of the current part.
PartsSize	The size of the current part.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
Range	The byte-range to be sent to the server.
Referer	Referer URL/document (optional).
Region	The region where the bucket is located.
SecretKey	The Secret Access Key for the Amazon Web Services account.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
UseSSL	Use SSL to access Amazon S3.
UseVirtualHosting	Determines which style request to use.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


AbortMultipartUpload	Aborts a multipart upload.
AddUserMetaData	Adds meta data to an object.
CompleteMultipartUpload	Completes a multipart upload by assembling previously uploaded parts.
Config	Sets or retrieves a configuration setting .
CopyObject	Make a copy of the specified object.
CopyPart	Copy the specified object as a part of a multipart upload.
CreateBucket	Creates a new bucket.
CreateObject	Puts an object into a bucket.
DeleteBucket	Deletes a bucket.
DeleteObject	Deletes the specified object.
DoEvents	Processes events from the internal message queue.
GetBucketLocation	Returns the location of the specified bucket.
GetLink	Creates a link to an object which expires in seconds specified.
GetObject	Gets an object from a bucket.
GetObjectInfo	Returns the meta-data for the indicated object.
GetTorrent	Gets an object from a bucket as a torrent.
GetXValue	Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Interrupt	Interrupt the current method.
ListBuckets	Lists all buckets in the account.
ListMultipartUploads	Lists current multipart uploads.
ListObjects	Lists all objects in a bucket.
ListParts	Lists all parts in a current multipart upload.
Reset	Resets request-related properties.
ResetHeaders	Resets all HTTP headers, cookies, and localfile.
SendCustomRequest	Allows the sending of a custom request to an Amazon web service.
StartMultipartUpload	Starts a multipart upload and returns an UploadId.
UpdateBucketACL	Updates the access policy of the specified bucket.
UpdateObjectACL	Updates the access policy of the specified object.
UploadPart	Uploads a part in a multipart upload.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


BucketList	Fired for every bucket when ListBuckets is called.
Connected	Fired immediately after a connection completes (or fails).
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
ObjectList	Fired for every object when ListObjects , or upload when ListMultipartUploads is called.
PartList	Fired for every part when ListParts is called.
PrefixList	Fired for every prefix returned as a common prefix.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


EventObjectSize	Used to retrieve the full object size from inside the ObjectList event.
ObjectSize	Used to set and retrieve object sizes information beyond the range of an integer.
ContentRange	This contains the range of bytes of the current object that are being returned.
CopyPartRange	Specifies the range of bytes to copy when calling CopyPart.
EncryptionIV	The initialization vector to be used for encryption/decryption.
EncryptionKey	The key to use during AES encryption/decryption.
ETag	The ETag for the object returned by the server.
IfMatch	Check to make sure the object has not been modified since the last request.
EnforceBucketNameRestrictions	Whether or not to enforce bucket naming conventions.
IncludeObjectMD5	Includes the MD5 digest of the object data if set.
IncludePartMD5	Includes the MD5 digest of the part data if set.
IsPaged	Whether or not all objects were returned by the last listing.
LocationConstraint	The location where buckets will be created.
MaxParts	The maximum number of parts in a multipart upload returned when calling ListParts.
MaxObjects	The maximum number of objects for the server to return.
PartNumberMarker	The marker indicating the start of the next part list.
Prefix[i]	The common prefix at index 'i'.
PrefixCount	The number of common prefixes.
PrefixOtherData[i]	The common prefix other data at index 'i'.
ProductToken	This is used with Amazon DevPay to charge users for S3 usage.
Region	The region where the bucket is located.
SigningTime	A custom date to send to the S3 component to use while signing all requests.
StoreObjectData	Whether component stores object data or not.
ResponseContentType	Sets the Content-Type header of the response.
ResponseContentLanguage	Sets the Content-Language header of the response.
ResponseExpires	Sets the Expires header of the response.
ResponseCacheControl	Sets the Cache-Control header of the response.
ResponseContentDisposition	Sets the Content-Disposition header of the response.
ResponseContentEncoding	Sets the Content-Encoding header of the response.
SignatureVersion	The version of signature used.
StorageClass	Specify the storage class to be used for the uploaded object.
StorePrefixList	If true, store the common prefixes when ListObjects is called.
TempPath	If set, the temporary files created during decryption will be put in the path specified.
UseServerSideEncryption	If true, use server side encryption.
UserToken	This is used with Amazon DevPay to charge users for S3 usage.
APIVersion	Amazon's API version.
HTTPMethod	Specifies the HTTP method to use when sending a custom request.
SignCustomRequest	Tells the component to sign the outgoing request.
TransferredData	Returns the entire XML response received from Amazon.
URL	If set, the default URL will be overridden by this value.
UseTransferAcceleration	TBD.
EnableTransferAcceleration	TBD.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.