(PureBasic) SQS Delete Message

Deletes a message from an SQS queue. You specify the message by using the message's receipt handle and not the message ID you received when you sent the message. This example will first receive a message, and then use the receipt handle to delete it.

See SQS DeleteMessage or detailed information.

Chilkat PureBasic Module Download

Chilkat PureBasic Module

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

Procedure ChilkatExample()

    ; 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","ReceiveMessage")
    CkRest::ckAddQueryParam(rest,"MaxNumberOfMessages","5")
    CkRest::ckAddQueryParam(rest,"VisibilityTimeout","15")
    CkRest::ckAddQueryParam(rest,"AttributeName","All")
    CkRest::ckAddQueryParam(rest,"MessageAttributeName","All")

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

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

    ; Examine the successful XML response.
    xml.i = CkXml::ckCreate()
    If xml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkXml::ckLoadXml(xml,responseXml)

    ; A successful response looks like this:
    ; <?xml version="1.0" encoding="utf-8" ?>
    ; <ReceiveMessageResponse xmlns="http://queue.amazonaws.com/doc/2012-11-05/">
    ;     <ReceiveMessageResult>
    ;         <Message>
    ;             <Body>this is a test</Body>
    ;             <MD5OfBody>54b0c58c7ce9f2a8b551351102ee0938</MD5OfBody>
    ;             <ReceiptHandle>AQEBMyLof...UbKBTvHtEg==</ReceiptHandle>
    ;             <Attribute>
    ;                 <Name>SenderId</Name>
    ;                 <Value>957491831129</Value>
    ;             </Attribute>
    ; ...
    ; ...
    ;             <MessageId>52882c65-5e21-4450-9024-93a3b01e61d3</MessageId>
    ;             <MD5OfMessageAttributes>2ff68603f4239272bd03f543254ed040</MD5OfMessageAttributes>
    ;         </Message>
    ;     </ReceiveMessageResult>
    ;     <ResponseMetadata>
    ;         <RequestId>05ba5c92-80ee-5f87-be76-0cf67b7475d6</RequestId>
    ;     </ResponseMetadata>
    ; </ReceiveMessageResponse>

    ; Get some values from the XML:
    receiptHandle.s = CkXml::ckChilkatPath(xml,"ReceiveMessageResult|Message|ReceiptHandle|*")
    Debug "ReceiptHandle = " + receiptHandle

    ; Now use the receipt handle to delete the message.
    ; Use the same connection (or automatically reconnect if needed)
    CkRest::ckClearAllQueryParams(rest)

    CkRest::ckAddQueryParam(rest,"Action","DeleteMessage")
    CkRest::ckAddQueryParam(rest,"ReceiptHandle",receiptHandle)

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

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

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

    ; A successful DeleteMessage response looks like this:
    ; <DeleteMessageResponse>
    ;     <ResponseMetadata>
    ;         <RequestId>
    ;             b5293cb5-d306-4a17-9048-b263635abe42
    ;         </RequestId>
    ;     </ResponseMetadata>
    ; </DeleteMessageResponse>


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


    ProcedureReturn
EndProcedure