AmazonGlacier Class
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 class allows you to simply access Amazon's Glacier service. Glacier allows you to create vaults and store archives.
Before using the class you must first have an AWS account and sign up for the Glacier service. To use the class 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 class 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. |
| 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. |
| Idle | The current status of the component. |
| InventoryData | Holds the inventory data. |
| JobMarker | A marker used to get the next page of results. |
| JobCount | The number of records in the Job arrays. |
| JobArchiveId | This property is populated with the ArchiveId associated with the Job. |
| JobArchiveSHA256TreeHash | The SHA256 tree hash of the entire archive for an archive retrieval job. |
| JobArchiveSize | The size of the archive in bytes. |
| JobCompleted | Indicates the completion status of the job. |
| JobCompletionDate | The UTC time that the job completed. |
| JobCreationDate | The UTC time that the job was created. |
| JobDescription | The user supplied description. |
| JobInventorySize | The size in bytes of the inventory data. |
| JobId | The Amazon assigned JobId. |
| JobSHA256TreeHash | The SHA256 tree hash value for the requested range of an archive. |
| JobSNSTopic | The Amazon SNS topic that will receive notifications about the job status. |
| JobStatusCode | The current status of the job. |
| JobStatusMessage | A user friendly description of the status. |
| JobType | The type of the current job. |
| JobVaultArn | The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested. |
| 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. |
| MultipartUploadCount | The number of records in the MultipartUpload arrays. |
| MultipartUploadArchiveDescription | The description of the archive (if any). |
| MultipartUploadCreationDate | The UTC time that the multipart upload was started. |
| MultipartUploadPartSize | The part size in bytes. |
| MultipartUploadId | The Id of the multipart upload. |
| MultipartUploadVaultArn | The Amazon Resource Name (ARN) of the Vault in which the archive is created. |
| NotifyEventType | This property specifies the type of enabled notifications for the vault. |
| NotifySNSTopic | This property specifies the Amazon SNS Topic ARN that is used to deliver notifications. |
| Overwrite | Whether or not the component should overwrite files during transfer. |
| PartMarker | A marker used to get the next page of results. |
| PartCount | The number of records in the Part arrays. |
| PartArchiveDescription | The description of the archive (if any). |
| PartCreationDate | The UTC time that the multipart upload was started. |
| PartSHA256TreeHash | The SHA256 tree hash value that Amazon calculated for the part. |
| PartSize | The part size in bytes. |
| PartStartPosition | The byte offset in the archive of the current part. |
| PartUploadId | The Id of the multipart upload associated with this part. |
| PartVaultArn | The Amazon Resource Name (ARN) of the Vault in which the archive is created. |
| 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. |
| 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). |
| Timeout | A timeout for the component. |
| UseSSL | Specifies if SSL is used. |
| VaultMarker | A marker used to get the next page of results. |
| VaultCount | The number of records in the Vault arrays. |
| VaultArchiveCount | The number of archives in the vault as of LastInventoryDate . |
| VaultArn | The Amazon Resource Name (ARN) of the vault. |
| VaultCreationDate | The date the vault was created, in Coordinated Universal Time (UTC). |
| VaultLastInventoryDate | The date of the last vault inventory, in Coordinated Universal Time (UTC). |
| VaultName | The name of the vault. |
| VaultSize | The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date. |
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. |
| 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. |
| SetNotificationInfo | Sets notification information for a vault. |
| 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 class 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 class 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. |