(PowerShell) 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 .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$rest = New-Object Chilkat.Rest

# Connect to the Amazon AWS REST server.
$bTls = $true
$port = 443
$bAutoReconnect = $true
$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 = New-Object Chilkat.AuthAws
$authAws.AccessKey = "AWS_ACCESS_KEY"
$authAws.SecretKey = "AWS_SECRET_KEY"
$authAws.ServiceName = "s3"
$success = $rest.SetAuthAws($authAws)

# Set the bucket name via the HOST header.
# In this case, the bucket name is "chilkat100".
$rest.Host = "chilkat100.s3.amazonaws.com"

# Send the request to download the JPG.
$success = $rest.SendReqNoBody("GET","/starfish.jpg")
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

# Read the response header.
$responseStatusCode = $rest.ReadResponseHeader()
if ($responseStatusCode -lt 0) {
    $($rest.LastErrorText)
    exit
}

$("Response status code = " + $responseStatusCode)

# 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 -eq 200) {

    $bodyStream = New-Object Chilkat.Stream

    # The stream's sink will be a file.
    $bodyStream.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,$true)
    if ($success -ne $true) {
        $($rest.LastErrorText)
        exit
    }

    $("Successfully received the JPG file.")

}
else {
    $errResponse = $rest.ReadRespBodyString()
    if ($rest.LastMethodSuccess -ne $true) {
        $($rest.LastErrorText)
    }
    else {
        $($errResponse)
    }

}