Cloud Storage Integrator - Online Help
Cloud Storage Integrator
Questions / Feedback?

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.

AccessKeyThe Access Key Id for the Amazon Web Services account.
ArchiveDataHolds the archive data.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
InventoryDataHolds the inventory data.
JobMarkerA marker used to get the next page of results.
JobsA collection providing details about the jobs.
LocalFileThe path to a local file for uploading or downloading.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MultipartUploadMarkerA marker used to get the next page of results.
MultipartUploadsA collection of multipart upload details.
NotificationInfoHolds information about the notification settings for a vault.
OverwriteWhether or not the component should overwrite files during transfer.
PartMarkerA marker used to get the next page of results.
PartsA collection of multipart upload parts.
ProxyA set of properties related to proxy access.
SecretKeyThe Secret Access Key for the Amazon Web Services account.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
UseSSLSpecifies if SSL is used.
VaultMarkerA marker used to get the next page of results.
VaultsA 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.

abortMultipartUploadAborts a multipart upload.
completeMultipartUploadCompletes a multipart upload.
configSets or retrieves a configuration setting .
createJobCreates a new job.
createVaultCreates a new vault.
deleteArchiveDeletes an archive.
deleteNotificationInfoDeletes the notification information for the vault.
deleteVaultDeletes the specified vault.
doEventsProcesses events from the internal message queue.
getJobInfoRetrieves information about the specified job.
getJobOutputRetrieves the output from the job.
getNotificationInfoRetrieves the notification information for the vault.
getVaultInfoRetrieves vault details.
interruptInterrupt the current method.
listJobsLists the jobs in a vault.
listMultipartUploadsLists multipart uploads.
listPartsLists the parts of a multipart upload.
listVaultsLists the vaults.
resetResets request-related properties.
sendCustomRequestAllows the sending of a custom request to an Amazon web service.
setDownloadStreamSets the stream to which the downloaded data from the server will be written.
setNotificationInfoSets notification information for a vault.
setUploadStreamSets the stream to be uploaded to the server.
startMultipartUploadStarts a multipart upload.
uploadArchiveUploads an archive to a vault.
uploadPartUploads 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.

ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
JobListFires once for each job returned when calling ListJobs or GetJobInfo.
MultipartUploadListFires once for each multipart upload when ListMultipartUploads is called.
PartListFires once for each part when calling ListParts.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).
VaultListFires 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.

APIVersionAmazon's API version.
HTTPMethodSpecifies the HTTP method to use when sending a custom request.
SignCustomRequestTells the component to sign the outgoing request.
TransferredDataReturns the entire XML response received from Amazon.
URLIf set, the default URL will be overridden by this value.
RequestIdThe Amazon generated RequestId.
LocationURIThe relative URI of the resource.
IsVaultPagedWhether or not the ListVaults results are paged.
IsJobPagedWhether or not the ListJobs results are paged.
IsPartPagedWhether or not the ListParts results are paged.
IsMultipartUploadPagedWhether or not the ListMultipartUploads results are paged.
MaxListVaultResultsThe maximum number of Vaults to return.
MaxListJobResultsThe maximum number of Jobs to return.
MaxListPartResultsThe maximum number of Parts to return.
MaxListMultipartUploadResultsThe maximum number of Multipart Uploads to return.
JobRetrievalByteRangeA range of bytes to retrieve.
JobOutputByteRangeThe byte range to retrieve.
JobDescriptionThe description for the job.
JobInventoryFormatThe format of data returned from an inventory retrieval.
PartSizeThe size in megabytes of each part in a multipart upload.
JobCompletionFilterSpecifies the state of jobs to return when calling ListJobs.
JobStatusFilterSpecifies the status of jobs to return when calling ListJobs.
RegionThe region in which the operations will take place.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 1.0.6240.0