/AWS1/IF_SNS=>CONFIRMSUBSCRIPTION()¶
About ConfirmSubscription¶
Verifies an endpoint owner's intent to receive messages by validating the token sent
to the endpoint by an earlier Subscribe action. If the token is valid, the
action creates a new subscription and returns its Amazon Resource Name (ARN). This call
requires an AWS signature only when the AuthenticateOnUnsubscribe flag is
set to "true".
Method Signature¶
METHODS /AWS1/IF_SNS~CONFIRMSUBSCRIPTION
IMPORTING
!IV_TOPICARN TYPE /AWS1/SNSTOPICARN OPTIONAL
!IV_TOKEN TYPE /AWS1/SNSTOKEN OPTIONAL
!IV_AUTHENTICATEONUNSUBSCRIBE TYPE /AWS1/SNSAUTHNTCTONUNSUBSCRIBE OPTIONAL
RETURNING
VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_snsconfsubscription01
RAISING
/AWS1/CX_SNSAUTHERROREXCEPTION
/AWS1/CX_SNSFILTPLYLIMITEXCDEX
/AWS1/CX_SNSINTERNALERROREX
/AWS1/CX_SNSINVALIDPARAMETEREX
/AWS1/CX_SNSNOTFOUNDEXCEPTION
/AWS1/CX_SNSREPLAYLIMITEXCDEX
/AWS1/CX_SNSSUBSCRIPTIONLMTE00
/AWS1/CX_SNSCLIENTEXC
/AWS1/CX_SNSSERVEREXC
/AWS1/CX_RT_TECHNICAL_GENERIC
/AWS1/CX_RT_SERVICE_GENERIC.
IMPORTING¶
Required arguments:¶
iv_topicarn TYPE /AWS1/SNSTOPICARN /AWS1/SNSTOPICARN¶
The ARN of the topic for which you wish to confirm a subscription.
iv_token TYPE /AWS1/SNSTOKEN /AWS1/SNSTOKEN¶
Short-lived token sent to an endpoint during the
Subscribeaction.
Optional arguments:¶
iv_authenticateonunsubscribe TYPE /AWS1/SNSAUTHNTCTONUNSUBSCRIBE /AWS1/SNSAUTHNTCTONUNSUBSCRIBE¶
Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is
trueand the request has an Amazon Web Services signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires Amazon Web Services authentication.
RETURNING¶
oo_output TYPE REF TO /aws1/cl_snsconfsubscription01 /AWS1/CL_SNSCONFSUBSCRIPTION01¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
Examples¶
Syntax Example¶
This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.
DATA(lo_result) = lo_client->confirmsubscription(
iv_authenticateonunsubscribe = |string|
iv_token = |string|
iv_topicarn = |string|
).
This is an example of reading all possible response values
lo_result = lo_result.
IF lo_result IS NOT INITIAL.
lv_subscriptionarn = lo_result->get_subscriptionarn( ).
ENDIF.