AmazonGlacier Bean

Properties Methods Events Configuration Settings Errors

The Glacier component provides a quick way to interface with Amazon's Glacier service.

Syntax

InCloudStorage.Amazonglacier

Remarks

The Glacier component allows you to simply access Amazon's Glacier service. Glacier allows you to create vaults and store archives.

Before using the component you must first have an AWS account and sign up for the Glacier service. To use the component first set AccessKey and SecretKey.

To create a vault call CreateVault. Once the vault is created you are ready to upload archives to store in the vault. Set LocalFile to the file you want to upload and call UploadArchive.

To retrieve an archive you must create a job. Jobs are long running operations and Amazon will notify you when the job is complete. To create a job call CreateJob. Use the SetNotificationInfo method to set notification options at the vault level. You may also supply an Amazon SNS topic to CreateJob to which Amazon will publish notification about the job status.

You can also call CreateJob to create an Inventory Retrieval job to list the contents of a vault.

After the job is complete use GetJobOutput to retrieve the data.

Additionally, multipart uploads are supported through the StartMultipartUpload and CompleteMultipartUpload methods. Various other operations such as DeleteArchive, GetJobInfo, ListJobs, ListMultipartUploads, ListVaults, and more provide additional functionality.

Property List

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


AccessKey	The Access Key Id for the Amazon Web Services account.
ArchiveData	Holds the archive data.
EncryptionAlgorithm	The encryption algorithm.
EncryptionPassword	The encryption password.
Firewall	A set of properties related to firewall access.
Idle	The current status of the component.
InventoryData	Holds the inventory data.
JobMarker	A marker used to get the next page of results.
Jobs	A collection providing details about the jobs.
LocalFile	The path to a local file for uploading or downloading.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MultipartUploadMarker	A marker used to get the next page of results.
MultipartUploads	A collection of multipart upload details.
NotificationInfo	Holds information about the notification settings for a vault.
Overwrite	Whether or not the component should overwrite files during transfer.
PartMarker	A marker used to get the next page of results.
Parts	A collection of multipart upload parts.
Proxy	A set of properties related to proxy access.
SecretKey	The Secret Access Key for the Amazon Web Services account.
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.
Timeout	A timeout for the component.
UseSSL	Specifies if SSL is used.
VaultMarker	A marker used to get the next page of results.
Vaults	A collection of vault information.

Method List

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


abortMultipartUpload	Aborts a multipart upload.
completeMultipartUpload	Completes a multipart upload.
config	Sets or retrieves a configuration setting .
createJob	Creates a new job.
createVault	Creates a new vault.
deleteArchive	Deletes an archive.
deleteNotificationInfo	Deletes the notification information for the vault.
deleteVault	Deletes the specified vault.
doEvents	Processes events from the internal message queue.
getJobInfo	Retrieves information about the specified job.
getJobOutput	Retrieves the output from the job.
getNotificationInfo	Retrieves the notification information for the vault.
getVaultInfo	Retrieves vault details.
interrupt	Interrupt the current method.
listJobs	Lists the jobs in a vault.
listMultipartUploads	Lists multipart uploads.
listParts	Lists the parts of a multipart upload.
listVaults	Lists the vaults.
reset	Resets request-related properties.
sendCustomRequest	Allows the sending of a custom request to an Amazon web service.
setDownloadStream	Sets the stream to which the downloaded data from the server will be written.
setNotificationInfo	Sets notification information for a vault.
setUploadStream	Sets the stream to be uploaded to the server.
startMultipartUpload	Starts a multipart upload.
uploadArchive	Uploads an archive to a vault.
uploadPart	Uploads a single part in a multipart upload.

Event List

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


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.
JobList	Fires once for each job returned when calling ListJobs or GetJobInfo.
MultipartUploadList	Fires once for each multipart upload when ListMultipartUploads is called.
PartList	Fires once for each part when calling ListParts.
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).
VaultList	Fires once for each vault returned when calling ListVaults.

Configuration Settings

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


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.
RequestId	The Amazon generated RequestId.
LocationURI	The relative URI of the resource.
IsVaultPaged	Whether or not the ListVaults results are paged.
IsJobPaged	Whether or not the ListJobs results are paged.
IsPartPaged	Whether or not the ListParts results are paged.
IsMultipartUploadPaged	Whether or not the ListMultipartUploads results are paged.
MaxListVaultResults	The maximum number of Vaults to return.
MaxListJobResults	The maximum number of Jobs to return.
MaxListPartResults	The maximum number of Parts to return.
MaxListMultipartUploadResults	The maximum number of Multipart Uploads to return.
JobRetrievalByteRange	A range of bytes to retrieve.
JobOutputByteRange	The byte range to retrieve.
JobDescription	The description for the job.
JobInventoryFormat	The format of data returned from an inventory retrieval.
PartSize	The size in megabytes of each part in a multipart upload.
JobCompletionFilter	Specifies the state of jobs to return when calling ListJobs.
JobStatusFilter	Specifies the status of jobs to return when calling ListJobs.
Region	The region in which the operations will take place.
EncryptionIV	The initialization vector to be used for encryption/decryption.
EncryptionKey	The key to use during encryption/decryption.
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.