/AWS1/CL_IOT=>CREATESTREAM()

About CreateStream

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream.

Requires permission to access the CreateStream action.

Method Signature

IMPORTING

Required arguments:

iv_streamid TYPE /AWS1/IOTSTREAMID /AWS1/IOTSTREAMID

The stream ID.

it_files TYPE /AWS1/CL_IOTSTREAMFILE=>TT_STREAMFILES TT_STREAMFILES

The files to stream.

iv_rolearn TYPE /AWS1/IOTROLEARN /AWS1/IOTROLEARN

An IAM role that allows the IoT service principal to access your S3 files.

Optional arguments:

iv_description TYPE /AWS1/IOTSTREAMDESCRIPTION /AWS1/IOTSTREAMDESCRIPTION

A description of the stream.

it_tags TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST TT_TAGLIST

Metadata which can be used to manage streams.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotcreatestreamrsp /AWS1/CL_IOTCREATESTREAMRSP

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->/aws1/if_iot~createstream(
  it_files = VALUE /aws1/cl_iotstreamfile=>tt_streamfiles(
    (
      new /aws1/cl_iotstreamfile(
        io_s3location = new /aws1/cl_iots3location(
          iv_bucket = |string|
          iv_key = |string|
          iv_version = |string|
        )
        iv_fileid = 123
      )
    )
  )
  it_tags = VALUE /aws1/cl_iottag=>tt_taglist(
    (
      new /aws1/cl_iottag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
  iv_rolearn = |string|
  iv_streamid = |string|
).

This is an example of reading all possible response values

lv_streamid = lo_result->get_streamid( ).
lv_streamarn = lo_result->get_streamarn( ).
lv_streamdescription = lo_result->get_description( ).
lv_streamversion = lo_result->get_streamversion( ).