AmazonS3 Component
Properties Methods Events Configuration Settings Errors
The AmazonS3 component provides an easy way to interface with Amazon's Simple Storage Service (S3).
Syntax
nsoftware.IPWorksCloud.Amazons3
Remarks
The AmazonS3 component 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 component with short descriptions. Click on the links for further details.
AccessKey | The access key to use for authentication. |
AccessPolicy | The canned access policy to apply to a bucket or object. |
Bucket | Selects a bucket. |
Buckets | A collection of buckets. |
ContentDisposition | Content disposition to send for an object. |
ContentType | Content type to send for an object. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The encryption password. |
Firewall | A set of properties related to firewall access. |
FollowRedirects | Determines what happens when the server issues a redirect. |
Idle | The current status of the component. |
LocalFile | The location of the local file. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
Metadata | A collection of metadata items. |
ObjectData | The data that was downloaded, or that should be uploaded. |
ObjectDelimiter | The delimiter string to use when listing objects. |
ObjectMarker | A marker indicating what page of objects to return next. |
ObjectPrefix | A prefix used to restrict the results returned when listing objects. |
Objects | A collection of objects. |
OtherHeaders | Other headers as determined by the user (optional). |
Overwrite | Determines if local files are overwritten. |
ParsedHeaders | Collection of headers returned from the last request. |
PartMarker | A marker indicating what page of parts to return next. |
Parts | A collection of multipart upload parts. |
Proxy | A set of properties related to proxy access. |
QueryParams | Additional query parameters to be included in the request. |
Range | The range of bytes to request. |
Region | The region the component will make requests against. |
SecretKey | The secret key to use for authentication. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
StartByte | The byte offset from which to resume the upload or download. |
Timeout | A timeout for the component. |
UseSSL | Whether to use SSL/TLS when connecting. |
UseVirtualHosting | Determines which URL style to use when making requests. |
VersionId | The object version to make requests against. |
VersioningEnabled | Controls whether versioning is enabled for the currently selected bucket. |
VersionMarker | A marker indicating what page of object versions to return next. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AbortMultipartUpload | Aborts a multipart upload. |
AddMetadata | Adds a metadata item to the Metadata properties. |
AddQueryParam | Adds a query parameter to the QueryParams properties. |
BucketExists | Checks whether the bucket exists. |
CompleteMultipartUpload | Completes a multipart upload by assembling previously uploaded parts. |
Config | Sets or retrieves a configuration setting. |
CopyObject | Copies an object. |
CopyPart | Copies the specified object as a part of a multipart upload. |
CreateBucket | Creates a new bucket. |
CreateObject | Creates a new object in the currently selected bucket. |
DeleteBucket | Deletes a bucket. |
DeleteObject | Deletes an object. |
DoEvents | Processes events from the internal message queue. |
GetBucketLocation | Gets a bucket's location. |
GetLink | Creates a link that provides access to an object for a specified amount of time. |
GetObject | Downloads an object. |
GetObjectInfo | Gets an object's information and metadata. |
GetTorrent | Gets a torrent file that can be used to download an object. |
Interrupt | Interrupt the current method. |
ListBuckets | Lists all buckets in the account. |
ListMultipartUploads | Lists the current multipart uploads. |
ListObjects | Lists the objects in a bucket. |
ListParts | Lists the parts in a multipart upload. |
ListVersions | Lists the object versions in a bucket. |
Reset | Resets the component to its initial state. |
ResetHeaders | Resets all HTTP headers, cookies, and LocalFile. |
SendCustomRequest | Sends a custom request to the server. |
SetDownloadStream | Sets the stream to which downloaded data will be written. |
SetUploadStream | Sets the stream from which data is read when uploading. |
StartMultipartUpload | Starts a new manual multipart upload. |
UpdateBucketACL | Updates a bucket's canned access policy. |
UpdateObjectACL | Updates an object's canned access policy. |
UploadPart | Uploads a multipart upload part. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
BucketList | Fires once for each bucket returned when listing buckets. |
EndTransfer | Fired when a document finishes transferring. |
Error | Information about errors during data delivery. |
FragmentComplete | Fires after each part in an automatic multipart upload is complete. |
Header | Fired every time a header line comes in. |
Log | Fires once for each log message. |
MetadataList | Fires once for each metadata item returned when object information and metadata is retrieved. |
ObjectList | Fires once for each object, object version, or multipart upload returned when listing such items. |
PartList | Fires once for every part returned when listing a multipart upload's parts. |
PrefixList | Fires once for each common prefix returned when listing objects. |
Progress | Fires during an upload or download to indicate transfer progress. |
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). |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AccumulatePages | Whether the component should accumulate subsequent pages of results when listing them. |
AssumeRoleARN | Amazon Resource Name used when assuming a role for authentication. |
AssumeRoleDuration | The durration for role session in seconds. |
AssumeRoleSessionName | Unique name for current role session. |
AutoDetectSigningRegion | Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process. |
AWSProfile | The name of the AWS CLI profile that the component should use to obtain authentication and region information. |
AWSProfileDir | The location of the AWS CLI credentials and config files. |
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. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
EnableTransferAcceleration | Specifies whether or not the current Bucket has transfer acceleration enabled. |
EncodeSlashInObjectName | Whether or not to encode slashes in an object name. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
EnforceBucketNameRestrictions | Whether or not to enforce bucket naming conventions. |
ETag | The ETag for the object returned by the server. |
FragmentSize | The part size to use when uploading a new object. |
IfMatch | Check to make sure the object has not been modified since the last request. |
IMDSv2SessionTokenDuration | The maximum duration of the session token. |
IMDSVersion | The version of Instance Metadata Service to use when accessing role credentials. |
IncludeContentMD5 | Whether an MD5 digest of a custom request's data should be included. |
IncludeObjectMD5 | Whether an MD5 digest of a object's data should be included. |
IncludePartMD5 | Whether an MD5 digest of a part's data should be included. |
MaskSensitive | Whether sensitive data is masked in the Log event. |
MaxObjects | The maximum number of results to return when listing objects. |
MaxParts | The maximum number of results to return when listing parts. |
Prefix[i] | The i'th common prefix returned. |
PrefixCount | The number of common prefixed returned. |
ProductToken | This is used with Amazon DevPay to charge users for S3 usage. |
ProgressAbsolute | Whether the component should track transfer progress absolutely. |
ProgressStep | How often the progress event should be fired, in terms of percentage. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
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. |
ResponseContentLanguage | Sets the Content-Language header of the response. |
ResponseContentType | Sets the Content-Type header of the response. |
ResponseExpires | Sets the Expires header of the response. |
ResumableUploadState | Tracks upload state information during an automatic multipart upload. |
SessionToken | The session token to send in the request when using temporary credentials. |
SignatureVersion | The signature version standard to use in all API requests. |
SignCustomRequest | Tells the component to sign the outgoing request. |
SigningTime | A custom date to send to the component to use while signing all requests. |
SimpleUploadLimit | The maximum data size the component should attempt to upload directly when creating an object. |
StorageClass | Specifies the storage class to be used for the uploaded object. |
StorePrefixList | Whether to store the common prefixes returned when listing objects. |
TempPath | The path to the directory where temporary files are created. |
URL | If set, the default URL will be overridden by this value. |
UseEC2RoleCredentials | Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. |
UserToken | This is used with Amazon DevPay to charge users for S3 usage. |
UseServerSideEncryption | If true, use server side encryption. |
UseTransferAcceleration | If true, uses the accelerated endpoint for the current Bucket during transfers. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
AllowNTLMFallback | Whether to allow fallback from Negotiate to NTLM when authenticating. |
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. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
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. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
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. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
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. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformDeflate | Whether to use the platform implementation to decompress compressed responses. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
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). |
FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
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. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
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 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. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |