(Perl) REST Stream Response to File (Streaming Download) (Amazon S3)

Demonstrates how to stream the response body directly to a file. (The example shows how to stream a JPG from the Amazon S3 service.)

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$rest = chilkat::CkRest->new();

# Connect to the Amazon AWS REST server.
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
$success = $rest->Connect("s3.amazonaws.com",$port,$bTls,$bAutoReconnect);

# ----------------------------------------------------------------------------
# Important: For buckets created in regions outside us-east-1,
# there are three important changes that need to be made.
# See Working with S3 Buckets in Non-us-east-1 Regions for the details.
# ----------------------------------------------------------------------------

# Provide AWS credentials for the REST call.
$authAws = chilkat::CkAuthAws->new();
$authAws->put_AccessKey("AWS_ACCESS_KEY");
$authAws->put_SecretKey("AWS_SECRET_KEY");
$authAws->put_ServiceName("s3");
$success = $rest->SetAuthAws($authAws);

# Set the bucket name via the HOST header.
# In this case, the bucket name is "chilkat100".
$rest->put_Host("chilkat100.s3.amazonaws.com");

# Send the request to download the JPG.
$success = $rest->SendReqNoBody("GET","/starfish.jpg");
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# Read the response header.
$responseStatusCode = $rest->ReadResponseHeader();
if ($responseStatusCode < 0) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

print "Response status code = " . $responseStatusCode . "\r\n";

# We expect a 200 response status if the JPG data is coming.
# Otherwise, we'll get a string response body with an error message(or no response body).
if ($responseStatusCode == 200) {

    $bodyStream = chilkat::CkStream->new();

    # The stream's sink will be a file.
    $bodyStream->put_SinkFile("qa_output/starfish.jpg");

    # Read the response body to the stream.  Given that we've
    # set the stream's sink to a file, it will stream directly
    # to the file.
    $success = $rest->ReadRespBodyStream($bodyStream,1);
    if ($success != 1) {
        print $rest->lastErrorText() . "\r\n";
        exit;
    }

    print "Successfully received the JPG file." . "\r\n";

}
else {
    $errResponse = $rest->readRespBodyString();
    if ($rest->get_LastMethodSuccess() != 1) {
        print $rest->lastErrorText() . "\r\n";
    }
    else {
        print $errResponse . "\r\n";
    }

}