SQL Server

Glacier Initiate Archive Retrieval Job

See more Amazon Glacier Examples

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

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

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

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

    DECLARE @rest int
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Connect to the Amazon AWS REST server in the desired region.
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'glacier.us-west-2.amazonaws.com', @port, @bTls, @bAutoReconnect

    -- Provide AWS credentials.
    DECLARE @authAws int
    EXEC @hr = sp_OACreate 'Chilkat.AuthAws', @authAws OUT

    EXEC sp_OASetProperty @authAws, 'AccessKey', 'AWS_ACCESS_KEY'
    EXEC sp_OASetProperty @authAws, 'SecretKey', 'AWS_SECRET_KEY'
    EXEC sp_OASetProperty @authAws, 'ServiceName', 'glacier'
    EXEC sp_OASetProperty @authAws, 'Region', 'us-west-2'

    EXEC sp_OAMethod @rest, 'SetAuthAws', @success OUT, @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
    -- 
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, '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

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'Type', 'archive-retrieval'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ArchiveId', 'ARCHIVE_ID'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'Description', 'My archive description'
    -- Possible tiers are Bulk, Standard, and Expedited.
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, '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.

    DECLARE @sbRequestBody int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbRequestBody OUT

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    -- Start an archive retrieval in for the vault named "chilkat".
    EXEC sp_OAMethod @rest, 'FullRequestSb', @success OUT, 'POST', '/AWS_ACCOUNT_ID/vaults/chilkat/jobs', @sbRequestBody, @sbResponseBody
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @authAws
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @respStatusCode OUT
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Status Code = ' + @respStatusCode

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @rest, 'ResponseHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Response Body:'
        EXEC sp_OAMethod @sbResponseBody, 'GetAsString', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @authAws
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    -- Success is indicated by a 202 response status with an empty response body.

    PRINT 'response status code = ' + @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
    -- 

    DECLARE @jobId nvarchar(4000)
    EXEC sp_OAMethod @rest, 'ResponseHdrByName', @jobId OUT, 'x-amz-job-id'

    PRINT 'x-amz-job-id = ' + @jobId

    DECLARE @location nvarchar(4000)
    EXEC sp_OAMethod @rest, 'ResponseHdrByName', @location OUT, 'Location'

    PRINT 'Location = ' + @location

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @authAws
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody
    EXEC @hr = sp_OADestroy @sbResponseBody


END
GO