Skip to content

/AWS1/IF_IOT=>UPDATEFLEETMETRIC()

About UpdateFleetMetric

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

Method Signature

METHODS /AWS1/IF_IOT~UPDATEFLEETMETRIC
  IMPORTING
    !IV_METRICNAME TYPE /AWS1/IOTFLEETMETRICNAME OPTIONAL
    !IV_QUERYSTRING TYPE /AWS1/IOTQUERYSTRING OPTIONAL
    !IO_AGGREGATIONTYPE TYPE REF TO /AWS1/CL_IOTAGGREGATIONTYPE OPTIONAL
    !IV_PERIOD TYPE /AWS1/IOTFLEETMETRICPERIOD OPTIONAL
    !IV_AGGREGATIONFIELD TYPE /AWS1/IOTAGGREGATIONFIELD OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/IOTFLEETMETRICDESC OPTIONAL
    !IV_QUERYVERSION TYPE /AWS1/IOTQUERYVERSION OPTIONAL
    !IV_INDEXNAME TYPE /AWS1/IOTINDEXNAME OPTIONAL
    !IV_UNIT TYPE /AWS1/IOTFLEETMETRICUNIT OPTIONAL
    !IV_EXPECTEDVERSION TYPE /AWS1/IOTOPTIONALVERSION OPTIONAL
  RAISING
    /AWS1/CX_IOTINDEXNOTREADYEX
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDAGGREX
    /AWS1/CX_IOTINVALIDQUERYEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTSERVICEUNAVAILEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTUNAUTHORIZEDEX
    /AWS1/CX_IOTVERSIONCONFLICTEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_metricname TYPE /AWS1/IOTFLEETMETRICNAME /AWS1/IOTFLEETMETRICNAME

The name of the fleet metric to update.

iv_indexname TYPE /AWS1/IOTINDEXNAME /AWS1/IOTINDEXNAME

The name of the index to search.

Optional arguments:

iv_querystring TYPE /AWS1/IOTQUERYSTRING /AWS1/IOTQUERYSTRING

The search query string.

io_aggregationtype TYPE REF TO /AWS1/CL_IOTAGGREGATIONTYPE /AWS1/CL_IOTAGGREGATIONTYPE

The type of the aggregation query.

iv_period TYPE /AWS1/IOTFLEETMETRICPERIOD /AWS1/IOTFLEETMETRICPERIOD

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

iv_aggregationfield TYPE /AWS1/IOTAGGREGATIONFIELD /AWS1/IOTAGGREGATIONFIELD

The field to aggregate.

iv_description TYPE /AWS1/IOTFLEETMETRICDESC /AWS1/IOTFLEETMETRICDESC

The description of the fleet metric.

iv_queryversion TYPE /AWS1/IOTQUERYVERSION /AWS1/IOTQUERYVERSION

The version of the query.

iv_unit TYPE /AWS1/IOTFLEETMETRICUNIT /AWS1/IOTFLEETMETRICUNIT

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

iv_expectedversion TYPE /AWS1/IOTOPTIONALVERSION /AWS1/IOTOPTIONALVERSION

The expected version of the fleet metric record in the registry.

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.

lo_client->updatefleetmetric(
  io_aggregationtype = new /aws1/cl_iotaggregationtype(
    it_values = VALUE /aws1/cl_iotaggrtypevalues_w=>tt_aggregationtypevalues(
      ( new /aws1/cl_iotaggrtypevalues_w( |string| ) )
    )
    iv_name = |string|
  )
  iv_aggregationfield = |string|
  iv_description = |string|
  iv_expectedversion = 123
  iv_indexname = |string|
  iv_metricname = |string|
  iv_period = 123
  iv_querystring = |string|
  iv_queryversion = |string|
  iv_unit = |string|
).