Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

CkPython Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(CkPython) Glacier Initiate Archive Retrieval Job

Demonstrates how to initiate an archive retrieval job to download an archive.

Note: This example requires Chilkat v9.5.0.78 or greater.

Chilkat Python Downloads

Python Module for Windows, Linux, Alpine Linux,
MAC OS X, Solaris, FreeBSD, OpenBSD,
Raspberry Pi and other single board computers

import sys
import chilkat

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

rest = chilkat.CkRest()

# Connect to the Amazon AWS REST server in the desired region.
bTls = True
port = 443
bAutoReconnect = True
success = rest.Connect("glacier.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

# Provide AWS credentials.
authAws = chilkat.CkAuthAws()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("AWS_SECRET_KEY")
authAws.put_ServiceName("glacier")
authAws.put_Region("us-west-2")

success = rest.SetAuthAws(authAws)

# --------------------------------------------------------------------------
# Note: The above REST connection and setup of the AWS credentials
# can be done once.  After connecting, any number of REST calls can be made.
# The "auto reconnect" property passed to rest.Connect indicates that if
# the connection is lost, a REST method call will automatically reconnect
# if needed.
# --------------------------------------------------------------------------

# 
# For more information, see Glacier Initiate Job Post Reference Documentation
# 
rest.AddHeader("x-amz-glacier-version","2012-06-01")

# The body of our request will contain this JSON:
# {
#   "Type": "archive-retrieval",
#   "ArchiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId"
#   "Description": "My archive description",
#   "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-ArchiveRetrieval-topic-Example",
#   "Tier" : "Bulk"
# }

# Use this online tool to generate the code from sample JSON: 
# Generate Code to Create JSON

json = chilkat.CkJsonObject()
json.UpdateString("Type","archive-retrieval")
json.UpdateString("ArchiveId","ARCHIVE_ID")
json.UpdateString("Description","My archive description")
# Possible tiers are Bulk, Standard, and Expedited.
json.UpdateString("Tier","Bulk")
# The SNSTopic is optional.  If included, then notification is sent to the SNS topic when the job is complete.
# This example will omit the SNSTopic.

sbRequestBody = chilkat.CkStringBuilder()
json.EmitSb(sbRequestBody)
sbResponseBody = chilkat.CkStringBuilder()

# Start an archive retrieval in for the vault named "chilkat".
success = rest.FullRequestSb("POST","/AWS_ACCOUNT_ID/vaults/chilkat/jobs",sbRequestBody,sbResponseBody)
if (success != True):
    print(rest.lastErrorText())
    sys.exit()

respStatusCode = rest.get_ResponseStatusCode()
if (respStatusCode >= 400):
    print("Response Status Code = " + str(respStatusCode))
    print("Response Header:")
    print(rest.responseHeader())
    print("Response Body:")
    print(sbResponseBody.getAsString())
    sys.exit()

# Success is indicated by a 202 response status with an empty response body.
print("response status code = " + str(respStatusCode))

# If successful, the response header looks like this.
# The Location and x-amz-job-id are two items of information we may wish to save..

# HTTP/1.1 202 Accepted
# x-amzn-RequestId: AAABZpJrTyioDC_HsOmHae8EZp_uBSJr6cnGOLKp_XJCl-Q
# Date: Wed, 10 Feb 2017 12:00:00 GMT 
# Location: /111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
# x-amz-job-id: HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID
# 

jobId = rest.responseHdrByName("x-amz-job-id")
print("x-amz-job-id = " + jobId)

location = rest.responseHdrByName("Location")
print("Location = " + location)

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.