(PureBasic) SNS Subscribe Email Address

Subscribe an email address to an SNS topic.

See SNS Subscribe for more 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://sns.us-west-2.amazonaws.com/
    bTls.i = 1
    port.i = 443
    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"sns.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, "sns")

    CkRest::ckSetAuthAws(rest,authAws)

    CkRest::ckAddQueryParam(rest,"Action","Subscribe")
    CkRest::ckAddQueryParam(rest,"Endpoint","somebody@some-email-address.com")
    CkRest::ckAddQueryParam(rest,"Protocol","email")
    CkRest::ckAddQueryParam(rest,"TopicArn","arn:aws:sns:us-west-2:957491831129:chilkat")

    responseXml.s = CkRest::ckFullRequestNoBody(rest,"GET","/")
    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)
    Debug CkXml::ckGetXml(xml)

    ; To get the SubscriptionArn (which in this case is "pending confirmation")
    Debug "SubscriptionArn: " + CkXml::ckChilkatPath(xml,"SubscribeResult|SubscriptionArn|*")

    ; A sample successful response:
    ; <?xml version="1.0" encoding="utf-8" ?>
    ; <SubscribeResponse xmlns="http://sns.amazonaws.com/doc/2010-03-31/">
    ;     <SubscribeResult>
    ;         <SubscriptionArn>pending confirmation</SubscriptionArn>
    ;     </SubscribeResult>
    ;     <ResponseMetadata>
    ;         <RequestId>c5490a81-973b-5fa6-93dc-5bed689c212f</RequestId>
    ;     </ResponseMetadata>
    ; </SubscribeResponse>


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


    ProcedureReturn
EndProcedure