Skip to content

/AWS1/IF_CUS=>ASSOCIATESTREAMFORSEGMENTS()

About AssociateStreamForSegments

Associates an Amazon Kinesis data stream to receive segment membership events for a given domain. This is a domain-level configuration that applies to all segment subscriptions within the domain. A domain can have only one associated stream at a time.

Method Signature

METHODS /AWS1/IF_CUS~ASSOCIATESTREAMFORSEGMENTS
  IMPORTING
    !IV_DOMAINNAME TYPE /AWS1/CUSNAME OPTIONAL
    !IV_DESTINATIONARN TYPE /AWS1/CUSDESTINATIONARNSTRING OPTIONAL
    !IV_DESTINATIONROLEARN TYPE /AWS1/CUSDESTINATIONROLEARN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cusassocstrmfrsegsrsp
  RAISING
    /AWS1/CX_CUSACCESSDENIEDEX
    /AWS1/CX_CUSBADREQUESTEX
    /AWS1/CX_CUSINTERNALSERVEREX
    /AWS1/CX_CUSRESOURCENOTFOUNDEX
    /AWS1/CX_CUSTHROTTLINGEX
    /AWS1/CX_CUSCLIENTEXC
    /AWS1/CX_CUSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_domainname TYPE /AWS1/CUSNAME /AWS1/CUSNAME

The unique name of the domain.

iv_destinationarn TYPE /AWS1/CUSDESTINATIONARNSTRING /AWS1/CUSDESTINATIONARNSTRING

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream to deliver segment membership events to. For example, arn:aws:kinesis:region:account-id:stream/stream-name.

iv_destinationrolearn TYPE /AWS1/CUSDESTINATIONROLEARN /AWS1/CUSDESTINATIONROLEARN

The Amazon Resource Name (ARN) of the IAM role that allows Customer Profiles service principal to assume the role for conducting AWS Key Management Service (KMS) and Amazon Kinesis operations. The role must grant the following Amazon Kinesis permissions to deliver segment membership events to the stream:

  • kinesis:PutRecord

  • kinesis:PutRecords

  • kinesis:DescribeStream

RETURNING

oo_output TYPE REF TO /aws1/cl_cusassocstrmfrsegsrsp /AWS1/CL_CUSASSOCSTRMFRSEGSRSP

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->associatestreamforsegments(
  iv_destinationarn = |string|
  iv_destinationrolearn = |string|
  iv_domainname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.