IPWorks Cloud 2020 Python Edition

Questions / Feedback?

AmazonGlacier Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class ipworkscloud.AmazonGlacier

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 access_key and secret_key.

To create a vault call create_vault. Once the vault is created you are ready to upload archives to store in the vault. Set local_file to the file you want to upload and call upload_archive.

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 create_job. Use the set_notification_info method to set notification options at the vault level. You may also supply an Amazon SNS topic to create_job to which Amazon will publish notification about the job status.

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

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

Additionally, multipart uploads are supported through the start_multipart_upload and complete_multipart_upload methods. Various other operations such as delete_archive, get_job_info, list_jobs, list_multipart_uploads, list_vaults, 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.

access_keyThe access key to use for authentication.
archive_dataHolds the archive data.
encryption_algorithmThe encryption algorithm.
encryption_passwordThe encryption password.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the TCP port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
idleThe current status of the class.
inventory_dataHolds the inventory data.
job_markerA marker used to get the next page of results.
job_countThe number of records in the Job arrays.
job_archive_idThis property is populated with the ArchiveId associated with the Job.
job_archive_sha256_tree_hashThe SHA256 tree hash of the entire archive for an archive retrieval job.
job_archive_sizeThe size of the archive in bytes.
job_completedIndicates the completion status of the job.
job_completion_dateThe UTC time that the job completed.
job_creation_dateThe UTC time that the job was created.
job_descriptionThe user supplied description.
job_inventory_sizeThe size in bytes of the inventory data.
job_idThe Amazon assigned JobId.
job_sha256_tree_hashThe SHA256 tree hash value for the requested range of an archive.
job_sns_topicThe Amazon SNS topic that will receive notifications about the job status.
job_status_codeThe current status of the job.
job_status_messageA user friendly description of the status.
job_typeThe type of the current job.
job_vault_arnThe Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.
local_fileThe path to a local file for uploading or downloading.
local_hostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
multipart_upload_markerA marker used to get the next page of results.
multipart_upload_countThe number of records in the MultipartUpload arrays.
multipart_upload_archive_descriptionThe description of the archive (if any).
multipart_upload_creation_dateThe UTC time that the multipart upload was started.
multipart_upload_part_sizeThe part size in bytes.
multipart_upload_idThe Id of the multipart upload.
multipart_upload_vault_arnThe Amazon Resource Name (ARN) of the Vault in which the archive is created.
notify_event_typeThis property specifies the type of enabled notifications for the vault.
notify_sns_topicThis property specifies the Amazon SNS Topic ARN that is used to deliver notifications.
other_headersOther headers as determined by the user (optional).
overwriteWhether or not the class should overwrite files during transfer.
parsed_header_countThe number of records in the ParsedHeader arrays.
parsed_header_fieldThis property contains the name of the HTTP header (same case as it is delivered).
parsed_header_valueThis property contains the header contents.
part_markerA marker used to get the next page of results.
part_countThe number of records in the Part arrays.
part_archive_descriptionThe description of the archive (if any).
part_creation_dateThe UTC time that the multipart upload was started.
part_sha256_tree_hashThe SHA256 tree hash value that Amazon calculated for the part.
part_sizeThe part size in bytes.
part_start_positionThe byte offset in the archive of the current part.
part_upload_idThe Id of the multipart upload associated with this part.
part_vault_arnThe Amazon Resource Name (ARN) of the Vault in which the archive is created.
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the TCP port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use SSL for the connection to the proxy.
proxy_userThis property contains a user name, if authentication is to be used for the proxy.
regionThe region the class will make requests against.
secret_keyThe secret key to use for authentication.
ssl_accept_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_storeThe name of the certificate store for the client certificate.
ssl_cert_store_passwordIf 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.
ssl_cert_store_typeThe type of certificate store for this certificate.
ssl_cert_subjectThe subject of the certificate used for client authentication.
ssl_server_cert_encodedThe certificate (PEM/base64 encoded).
timeoutA timeout for the class.
use_sslWhether to use SSL/TLS when connecting.
vault_markerA marker used to get the next page of results.
vault_countThe number of records in the Vault arrays.
vault_archive_countThe number of archives in the vault as of LastInventoryDate .
vault_arnThe Amazon Resource Name (ARN) of the vault.
vault_creation_dateThe date the vault was created, in Coordinated Universal Time (UTC).
vault_last_inventory_dateThe date of the last vault inventory, in Coordinated Universal Time (UTC).
vault_nameThe name of the vault.
vault_sizeThe 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.

abort_multipart_uploadAborts a multipart upload.
complete_multipart_uploadCompletes a multipart upload.
configSets or retrieves a configuration setting.
create_jobCreates a new job.
create_vaultCreates a new vault.
delete_archiveDeletes an archive.
delete_notification_infoDeletes the notification information for the vault.
delete_vaultDeletes the specified vault.
do_eventsProcesses events from the internal message queue.
get_job_infoRetrieves information about the specified job.
get_job_outputRetrieves the output from the job.
get_notification_infoRetrieves the notification information for the vault.
get_vault_infoRetrieves vault details.
interruptInterrupt the current method.
list_jobsLists the jobs in a vault.
list_multipart_uploadsLists multipart uploads.
list_partsLists the parts of a multipart upload.
list_vaultsLists the vaults.
resetResets the class to its initial state.
set_notification_infoSets notification information for a vault.
start_multipart_uploadStarts a multipart upload.
upload_archiveUploads an archive to a vault.
upload_partUploads 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.

on_end_transferFired when a document finishes transferring.
on_errorInformation about errors during data delivery.
on_headerFired every time a header line comes in.
on_job_listFires once for each job returned when calling ListJobs or GetJobInfo.
on_logFires once for each log message.
on_multipart_upload_listFires once for each multipart upload when ListMultipartUploads is called.
on_part_listFires once for each part when calling ListParts.
on_progressFires during an upload or download to indicate transfer progress.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_start_transferFired when a document starts transferring (after the headers).
on_transferFired while a document transfers (delivers document).
on_vault_listFires 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.

AccumulatePagesWhether the class should accumulate subsequent pages of results when listing them.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
IsJobPagedWhether or not the ListJobs results are paged.
IsMultipartUploadPagedWhether or not the ListMultipartUploads results are paged.
IsPartPagedWhether or not the ListParts results are paged.
IsVaultPagedWhether or not the ListVaults results are paged.
JobCompletionFilterSpecifies the state of jobs to return when calling ListJobs.
JobDescriptionThe description for the job.
JobInventoryFormatThe format of data returned from an inventory retrieval.
JobOutputByteRangeThe byte range to retrieve.
JobRetrievalByteRangeA range of bytes to retrieve.
JobStatusFilterSpecifies the status of jobs to return when calling ListJobs.
LocationURIThe relative URI of the resource.
MaxListJobResultsThe maximum number of Jobs to return.
MaxListMultipartUploadResultsThe maximum number of Multipart Uploads to return.
MaxListPartResultsThe maximum number of Parts to return.
MaxListVaultResultsThe maximum number of Vaults to return.
PartSizeThe size in megabytes of each part in a multipart upload.
ProgressAbsoluteWhether the class should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RequestIdThe Amazon generated RequestId.
TransferredDataReturns the entire XML response received from the server.
URLIf set, the default URL will be overridden by this value.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
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.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
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.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class 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.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
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).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Python Edition - Version 20.0 [Build 8265]