AmazonGlacier Class
Properties Methods Events Configuration Settings Errors
The AmazonGlacier class provides a quick way to interface with Amazon's Glacier service.
Syntax
IPWorksCloudAmazonGlacier
IPWorksCloudAmazonGlacierSwift
Remarks
The AmazonGlacier 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 to use for authentication. |
| - archiveData | Holds the archive data. |
| - encryptionAlgorithm | The encryption algorithm. |
| - encryptionPassword | The encryption password. |
| - firewallAutoDetect | This property tells the class 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 class. |
| - 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:(int)jobIndex | This property is populated with the ArchiveId associated with the Job. |
| - jobArchiveSHA256TreeHash:(int)jobIndex | The SHA256 tree hash of the entire archive for an archive retrieval job. |
| - jobArchiveSize:(int)jobIndex | The size of the archive in bytes. |
| - jobCompleted:(int)jobIndex | Indicates the completion status of the job. |
| - jobCompletionDate:(int)jobIndex | The UTC time that the job completed. |
| - jobCreationDate:(int)jobIndex | The UTC time that the job was created. |
| - jobDescription:(int)jobIndex | The user supplied description. |
| - jobInventorySize:(int)jobIndex | The size in bytes of the inventory data. |
| - jobId:(int)jobIndex | The Amazon assigned JobId. |
| - jobSHA256TreeHash:(int)jobIndex | The SHA256 tree hash value for the requested range of an archive. |
| - jobSNSTopic:(int)jobIndex | The Amazon SNS topic that will receive notifications about the job status. |
| - jobStatusCode:(int)jobIndex | The current status of the job. |
| - jobStatusMessage:(int)jobIndex | A user friendly description of the status. |
| - jobType:(int)jobIndex | The type of the current job. |
| - jobVaultArn:(int)jobIndex | 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:(int)multipartUploadIndex | The description of the archive (if any). |
| - multipartUploadCreationDate:(int)multipartUploadIndex | The UTC time that the multipart upload was started. |
| - multipartUploadPartSize:(int)multipartUploadIndex | The part size in bytes. |
| - multipartUploadId:(int)multipartUploadIndex | The Id of the multipart upload. |
| - multipartUploadVaultArn:(int)multipartUploadIndex | 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. |
| - otherHeaders | Other headers as determined by the user (optional). |
| - overwrite | Whether or not the class should overwrite files during transfer. |
| - parsedHeaderCount | The number of records in the ParsedHeader arrays. |
| - parsedHeaderField:(int)parsedHeaderIndex | This property contains the name of the HTTP header (same case as it is delivered). |
| - parsedHeaderValue:(int)parsedHeaderIndex | This property contains the header contents. |
| - partMarker | A marker used to get the next page of results. |
| - partCount | The number of records in the Part arrays. |
| - partArchiveDescription:(int)partIndex | The description of the archive (if any). |
| - partCreationDate:(int)partIndex | The UTC time that the multipart upload was started. |
| - partSHA256TreeHash:(int)partIndex | The SHA256 tree hash value that Amazon calculated for the part. |
| - partSize:(int)partIndex | The part size in bytes. |
| - partStartPosition:(int)partIndex | The byte offset in the archive of the current part. |
| - partUploadId:(int)partIndex | The Id of the multipart upload associated with this part. |
| - partVaultArn:(int)partIndex | The Amazon Resource Name (ARN) of the Vault in which the archive is created. |
| - proxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
| - proxyAutoDetect | This property tells the class 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. |
| - region | The region the class will make requests against. |
| - secretKey | The secret key to use for authentication. |
| - 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 class. |
| - useSSL | Whether to use SSL/TLS when connecting. |
| - vaultMarker | A marker used to get the next page of results. |
| - vaultCount | The number of records in the Vault arrays. |
| - vaultArchiveCount:(int)vaultIndex | The number of archives in the vault as of LastInventoryDate . |
| - vaultArn:(int)vaultIndex | The Amazon Resource Name (ARN) of the vault. |
| - vaultCreationDate:(int)vaultIndex | The date the vault was created, in Coordinated Universal Time (UTC). |
| - vaultLastInventoryDate:(int)vaultIndex | The date of the last vault inventory, in Coordinated Universal Time (UTC). |
| - vaultName:(int)vaultIndex | The name of the vault. |
| - vaultSize:(int)vaultIndex | 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 the class to its initial state. |
| - 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.
| - onEndTransfer | Fired when a document finishes transferring. |
| - onError | Information about errors during data delivery. |
| - onHeader | Fired every time a header line comes in. |
| - onJobList | Fires once for each job returned when calling ListJobs or GetJobInfo. |
| - onLog | Fires once for each log message. |
| - onMultipartUploadList | Fires once for each multipart upload when ListMultipartUploads is called. |
| - onPartList | Fires once for each part when calling ListParts. |
| - onProgress | Fires during an upload or download to indicate transfer progress. |
| - onSSLServerAuthentication | Fired after the server presents its certificate to the client. |
| - onSSLStatus | Shows the progress of the secure connection. |
| - onStartTransfer | Fired when a document starts transferring (after the headers). |
| - onTransfer | Fired while a document transfers (delivers document). |
| - onVaultList | 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.
| AccumulatePages | Whether the class should accumulate subsequent pages of results when listing them. |
| EncryptionIV | The initialization vector to be used for encryption/decryption. |
| EncryptionKey | The key to use during encryption/decryption. |
| IsJobPaged | Whether or not the ListJobs results are paged. |
| IsMultipartUploadPaged | Whether or not the ListMultipartUploads results are paged. |
| IsPartPaged | Whether or not the ListParts results are paged. |
| IsVaultPaged | Whether or not the ListVaults results are paged. |
| JobCompletionFilter | Specifies the state of jobs to return when calling ListJobs. |
| JobDescription | The description for the job. |
| JobInventoryFormat | The format of data returned from an inventory retrieval. |
| JobOutputByteRange | The byte range to retrieve. |
| JobRetrievalByteRange | A range of bytes to retrieve. |
| JobStatusFilter | Specifies the status of jobs to return when calling ListJobs. |
| LocationURI | The relative URI of the resource. |
| MaxListJobResults | The maximum number of Jobs to return. |
| MaxListMultipartUploadResults | The maximum number of Multipart Uploads to return. |
| MaxListPartResults | The maximum number of Parts to return. |
| MaxListVaultResults | The maximum number of Vaults to return. |
| PartSize | The size in megabytes of each part in a multipart upload. |
| ProgressAbsolute | Whether the class should track transfer progress absolutely. |
| ProgressStep | How often the progress event should be fired, in terms of percentage. |
| RequestId | The Amazon generated RequestId. |
| TransferredData | Returns the entire XML response received from the server. |
| URL | If set, the default URL will be overridden by this value. |
| 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. |
| 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 class. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the class 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 class. |
| 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. |
| 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 class. |
| 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. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the class 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. |
| 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 class 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. |
| LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
| 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). |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
| 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |