(PureBasic) SQS Send Message

Note: This example requires a patch to work properly. It requires Chilkat v9.5.0.61, which can be obtained upon request to support@chilkatsoft.com

Delivers a message to the specified queue. With Amazon SQS, you now have the ability to send large payload messages that are up to 256KB (262,144 bytes) in size.

See SQS SendMessage or detailed information.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkXml.pb"
IncludeFile "CkAuthAws.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    ; Note: This example requires a patch to work properly.  
    ; It requires Chilkat v9.5.0.61, which can be obtained upon request to support@chilkatsoft.com

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

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to the Amazon AWS REST server.
    ; such as https://sqs.us-west-2.amazonaws.com/
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"sqs.us-west-2.amazonaws.com",port,bTls,bAutoReconnect)

    ; Provide AWS credentials for the REST call.
    authAws.i = CkAuthAws::ckCreate()
    If authAws.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
    CkAuthAws::setCkSecretKey(authAws, "AWS_SECRET_KEY")
    ; the region should match our URL above..
    CkAuthAws::setCkRegion(authAws, "us-west-2")
    CkAuthAws::setCkServiceName(authAws, "sqs")

    CkRest::ckSetAuthAws(rest,authAws)

    CkRest::ckAddQueryParam(rest,"Action","SendMessage")
    CkRest::ckAddQueryParam(rest,"MessageBody","This is the message body which can be up to 256K in size.")
    CkRest::ckAddQueryParam(rest,"MessageAttribute.1.Name","test_attribute_name_1")
    CkRest::ckAddQueryParam(rest,"MessageAttribute.1.Value.StringValue","test_attribute_value_1")
    CkRest::ckAddQueryParam(rest,"MessageAttribute.1.Value.DataType","String")
    CkRest::ckAddQueryParam(rest,"MessageAttribute.2.Name","test_attribute_name_2")
    CkRest::ckAddQueryParam(rest,"MessageAttribute.2.Value.StringValue","test_attribute_value_2")
    CkRest::ckAddQueryParam(rest,"MessageAttribute.2.Value.DataType","String")

    ; Use the actual path part of your SQS queue URL here:
    responseXml.s = CkRest::ckFullRequestFormUrlEncoded(rest,"POST","/123456789123/chilkatTest")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        ProcedureReturn
    EndIf

    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; A successful response will have a status code equal to 200.
    If CkRest::ckResponseStatusCode(rest) <> 200
        Debug "request header = " + CkRest::ckLastRequestHeader(rest)
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        CkXml::ckLoadXml(xml,responseXml)
        Debug CkXml::ckGetXml(xml)
        CkRest::ckDispose(rest)
        CkAuthAws::ckDispose(authAws)
        CkXml::ckDispose(xml)
        ProcedureReturn
    EndIf

    ; Examine the successful XML response.
    CkXml::ckLoadXml(xml,responseXml)
    Debug CkXml::ckGetXml(xml)
    Debug "----"

    ; A successful response looks like this:
    ; <?xml version="1.0" encoding="utf-8" ?>
    ; <SendMessageResponse>
    ;     <SendMessageResult>
    ;         <MD5OfMessageBody>
    ;             fafb00f5732ab283681e124bf8747ed1
    ;         </MD5OfMessageBody>
    ;         <MD5OfMessageAttributes>
    ; 	    3ae8f24a165a8cedc005670c81a27295
    ;         </MD5OfMessageAttributes>
    ;         <MessageId>
    ;             5fea7756-0ea4-451a-a703-a558b933e274
    ;         </MessageId>
    ;     </SendMessageResult>
    ;     <ResponseMetadata>
    ;         <RequestId>
    ;             27daac76-34dd-47df-bd01-1f6e873584a0
    ;         </RequestId>
    ;     </ResponseMetadata>
    ; </SendMessageResponse>

    ; Get some values from the response XML:
    Debug "Body: " + CkXml::ckChilkatPath(xml,"SendMessageResult|MD5OfMessageBody|*")
    Debug "MessageId: " + CkXml::ckChilkatPath(xml,"SendMessageResult|MessageId|*")
    Debug "RequestId: " + CkXml::ckChilkatPath(xml,"ResponseMetadata|RequestId|*")


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkXml::ckDispose(xml)


    ProcedureReturn
EndProcedure