Subscribe

Subscribe #

Overview #

Prepares to subscribe an endpoint by sending the endpoint a confirmation message.

AWS API Reference: https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html

Method # 

SUBSCRIBE_TOPIC

Import parameters #

This method uses the following import parameters.

  • i_user_name

    Required: Yes.

    The IAM user of AWS account.

  • i_arn

    Required: Yes.

    Value of the Amazon Resource Name (ARN) of the new topic.

  • i_region

    Required: Yes.

    Name of the region.

  • i_endpoint

    Required: Yes.

    Value of the endpoint.

  • i_protocol

    Required: Yes.

    Value of the protocol.

Export Parameters #

This method use the following export parameters:

  • e_http_status

    HTTP Status code. Returns 200 if no errors found.

  • e_response_headers

    Returns information about the request in format Name/Value pair values.

  • e_response_content

    Response content in string format.

Example # 

DATA: lo_sns_topic   TYPE REF TO /lnkaws/cl_aws_sns_topic,
      lo_cx_aws_s3   TYPE REF TO /lnkaws/cx_aws_s3,
      lv_http_status TYPE i,
      lv_headers     TYPE tihttpnvp,
      lv_content     TYPE string.
TRY.
    CREATE OBJECT lo_sns_topic
      EXPORTING
        i_region    = 'eu-west-1'
        i_user_name = 'userawsconnector'.
    CALL METHOD lo_sns_topic->subscribe_topic
      EXPORTING
        i_user_name        = 'userawsconnector'
        i_arn              = 'arn value'
        i_region           = 'eu-west-1'
        i_endpoint         = 'endpoint value'
        i_protocol         = 'protocol value'
      IMPORTING
        e_http_status      = lv_http_status
        e_response_headers = lv_headers
        e_response_content = lv_content.
  CATCH /lnkaws/cx_aws_s3 INTO lo_cx_aws_s3.
    RAISE EXCEPTION lo_cx_aws_s3.
ENDTRY.