(Tcl) 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 Tcl Extension Downloads

Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set rest [new_CkRest]

# Connect to the Amazon AWS REST server.
# such as https://sqs.us-west-2.amazonaws.com/
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "sqs.us-west-2.amazonaws.com" $port $bTls $bAutoReconnect]

# Provide AWS credentials for the REST call.
set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"
# the region should match our URL above..
CkAuthAws_put_Region $authAws "us-west-2"
CkAuthAws_put_ServiceName $authAws "sqs"

CkRest_SetAuthAws $rest $authAws

CkRest_AddQueryParam $rest "Action" "ReceiveMessage"
CkRest_AddQueryParam $rest "MaxNumberOfMessages" "5"
CkRest_AddQueryParam $rest "VisibilityTimeout" "15"
CkRest_AddQueryParam $rest "AttributeName" "All"
CkRest_AddQueryParam $rest "MessageAttributeName" "All"

# Use the actual path part of your SQS queue URL here:
set responseXml [CkRest_fullRequestNoBody $rest "GET" "/123456789123/chilkatTest"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# A successful response will have a status code equal to 200.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body: $responseXml"
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    exit
}

# Examine the successful XML response.
set xml [new_CkXml]

CkXml_LoadXml $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:
set receiptHandle [CkXml_chilkatPath $xml "ReceiveMessageResult|Message|ReceiptHandle|*"]
puts "ReceiptHandle = $receiptHandle"

# Now use the receipt handle to delete the message.
# Use the same connection (or automatically reconnect if needed)
CkRest_ClearAllQueryParams $rest

CkRest_AddQueryParam $rest "Action" "DeleteMessage"
CkRest_AddQueryParam $rest "ReceiptHandle" $receiptHandle

# Use the actual path part of your SQS queue URL here:
set responseXml [CkRest_fullRequestNoBody $rest "GET" "/123456789123/chilkatTest"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkXml $xml
    exit
}

# A successful response will have a status code equal to 200.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body: $responseXml"
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkXml $xml
    exit
}

# Examine the successful XML response.
CkXml_LoadXml $xml $responseXml
puts [CkXml_getXml $xml]

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

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkXml $xml