Skip to content

/AWS1/IF_IOS=>PUTSTORAGECONFIGURATION()

About PutStorageConfiguration

Configures storage settings for IoT SiteWise.

Method Signature

METHODS /AWS1/IF_IOS~PUTSTORAGECONFIGURATION
  IMPORTING
    !IV_STORAGETYPE TYPE /AWS1/IOSSTORAGETYPE OPTIONAL
    !IO_MULTILAYERSTORAGE TYPE REF TO /AWS1/CL_IOSMULTILAYERSTORAGE OPTIONAL
    !IV_DISASSOCIATEDDATASTORAGE TYPE /AWS1/IOSDISASSCDDATASTRGSTATE OPTIONAL
    !IO_RETENTIONPERIOD TYPE REF TO /AWS1/CL_IOSRETENTIONPERIOD OPTIONAL
    !IV_WARMTIER TYPE /AWS1/IOSWARMTIERSTATE OPTIONAL
    !IO_WARMTIERRETENTIONPERIOD TYPE REF TO /AWS1/CL_IOSWARMTIERRETPERIOD OPTIONAL
    !IV_DISALLOWINGESTNULLNAN TYPE /AWS1/IOSDISALLOWINGESTNULLNAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iosputstorageconfrsp
  RAISING
    /AWS1/CX_IOSCNFLCTOPERATIONEX
    /AWS1/CX_IOSINTERNALFAILUREEX
    /AWS1/CX_IOSINVALIDREQUESTEX
    /AWS1/CX_IOSLIMITEXCEEDEDEX
    /AWS1/CX_IOSRESRCALRDYEXISTSEX
    /AWS1/CX_IOSRESOURCENOTFOUNDEX
    /AWS1/CX_IOSTHROTTLINGEX
    /AWS1/CX_IOSCLIENTEXC
    /AWS1/CX_IOSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_storagetype TYPE /AWS1/IOSSTORAGETYPE /AWS1/IOSSTORAGETYPE

The storage tier that you specified for your data. The storageType parameter can be one of the following values:

  • SITEWISE_DEFAULT_STORAGE – IoT SiteWise saves your data into the hot tier. The hot tier is a service-managed database.

  • MULTI_LAYER_STORAGE – IoT SiteWise saves your data in both the cold tier and the hot tier. The cold tier is a customer-managed Amazon S3 bucket.

Optional arguments:

io_multilayerstorage TYPE REF TO /AWS1/CL_IOSMULTILAYERSTORAGE /AWS1/CL_IOSMULTILAYERSTORAGE

Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object.

iv_disassociateddatastorage TYPE /AWS1/IOSDISASSCDDATASTRGSTATE /AWS1/IOSDISASSCDDATASTRGSTATE

Contains the storage configuration for time series (data streams) that aren't associated with asset properties. The disassociatedDataStorage can be one of the following values:

  • ENABLED – IoT SiteWise accepts time series that aren't associated with asset properties.

    After the disassociatedDataStorage is enabled, you can't disable it.

  • DISABLED – IoT SiteWise doesn't accept time series (data streams) that aren't associated with asset properties.

For more information, see Data streams in the IoT SiteWise User Guide.

io_retentionperiod TYPE REF TO /AWS1/CL_IOSRETENTIONPERIOD /AWS1/CL_IOSRETENTIONPERIOD

retentionPeriod

iv_warmtier TYPE /AWS1/IOSWARMTIERSTATE /AWS1/IOSWARMTIERSTATE

A service managed storage tier optimized for analytical queries. It stores periodically uploaded, buffered and historical data ingested with the CreaeBulkImportJob API.

io_warmtierretentionperiod TYPE REF TO /AWS1/CL_IOSWARMTIERRETPERIOD /AWS1/CL_IOSWARMTIERRETPERIOD

Set this period to specify how long your data is stored in the warm tier before it is deleted. You can set this only if cold tier is enabled.

iv_disallowingestnullnan TYPE /AWS1/IOSDISALLOWINGESTNULLNAN /AWS1/IOSDISALLOWINGESTNULLNAN

Describes the configuration for ingesting NULL and NaN data. By default the feature is allowed. The feature is disallowed if the value is true.

RETURNING

oo_output TYPE REF TO /aws1/cl_iosputstorageconfrsp /AWS1/CL_IOSPUTSTORAGECONFRSP

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->putstorageconfiguration(
  io_multilayerstorage = new /aws1/cl_iosmultilayerstorage(
    io_customermanageds3storage = new /aws1/cl_ioscusmanageds3strg(
      iv_rolearn = |string|
      iv_s3resourcearn = |string|
    )
  )
  io_retentionperiod = new /aws1/cl_iosretentionperiod(
    iv_numberofdays = 123
    iv_unlimited = ABAP_TRUE
  )
  io_warmtierretentionperiod = new /aws1/cl_ioswarmtierretperiod(
    iv_numberofdays = 123
    iv_unlimited = ABAP_TRUE
  )
  iv_disallowingestnullnan = ABAP_TRUE
  iv_disassociateddatastorage = |string|
  iv_storagetype = |string|
  iv_warmtier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_storagetype = lo_result->get_storagetype( ).
  lo_multilayerstorage = lo_result->get_multilayerstorage( ).
  IF lo_multilayerstorage IS NOT INITIAL.
    lo_customermanageds3storag = lo_multilayerstorage->get_customermanageds3storage( ).
    IF lo_customermanageds3storag IS NOT INITIAL.
      lv_arn = lo_customermanageds3storag->get_s3resourcearn( ).
      lv_arn = lo_customermanageds3storag->get_rolearn( ).
    ENDIF.
  ENDIF.
  lv_disassociateddatastorag = lo_result->get_disassociateddatastorage( ).
  lo_retentionperiod = lo_result->get_retentionperiod( ).
  IF lo_retentionperiod IS NOT INITIAL.
    lv_numberofdays = lo_retentionperiod->get_numberofdays( ).
    lv_unlimited = lo_retentionperiod->get_unlimited( ).
  ENDIF.
  lo_configurationstatus = lo_result->get_configurationstatus( ).
  IF lo_configurationstatus IS NOT INITIAL.
    lv_configurationstate = lo_configurationstatus->get_state( ).
    lo_configurationerrordetai = lo_configurationstatus->get_error( ).
    IF lo_configurationerrordetai IS NOT INITIAL.
      lv_errorcode = lo_configurationerrordetai->get_code( ).
      lv_errormessage = lo_configurationerrordetai->get_message( ).
    ENDIF.
  ENDIF.
  lv_warmtierstate = lo_result->get_warmtier( ).
  lo_warmtierretentionperiod = lo_result->get_warmtierretentionperiod( ).
  IF lo_warmtierretentionperiod IS NOT INITIAL.
    lv_numberofdays = lo_warmtierretentionperiod->get_numberofdays( ).
    lv_unlimited = lo_warmtierretentionperiod->get_unlimited( ).
  ENDIF.
  lv_disallowingestnullnan = lo_result->get_disallowingestnullnan( ).
ENDIF.