update_fleet_metric

update_fleet_metric(**kwargs)

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

See also: AWS API Documentation

Request Syntax

response = client.update_fleet_metric(
    metricName='string',
    queryString='string',
    aggregationType={
        'name': 'Statistics'|'Percentiles'|'Cardinality',
        'values': [
            'string',
        ]
    },
    period=123,
    aggregationField='string',
    description='string',
    queryVersion='string',
    indexName='string',
    unit='Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
    expectedVersion=123
)

Parameters

• metricName (string) --

  [REQUIRED]

  The name of the fleet metric to update.

• queryString (string) -- The search query string.
• aggregationType (dict) --

  The type of the aggregation query.

  • name (string) -- [REQUIRED]

    The name of the aggregation type.

  • values (list) --

    A list of the values of aggregation types.

    • (string) --
• period (integer) -- The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
• aggregationField (string) -- The field to aggregate.
• description (string) -- The description of the fleet metric.
• queryVersion (string) -- The version of the query.
• indexName (string) --

  [REQUIRED]

  The name of the index to search.

• unit (string) -- Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
• expectedVersion (integer) -- The expected version of the fleet metric record in the registry.

Returns

None

Exceptions

• IoT.Client.exceptions.InvalidRequestException
• IoT.Client.exceptions.ThrottlingException
• IoT.Client.exceptions.UnauthorizedException
• IoT.Client.exceptions.ServiceUnavailableException
• IoT.Client.exceptions.InternalFailureException
• IoT.Client.exceptions.ResourceNotFoundException
• IoT.Client.exceptions.InvalidQueryException
• IoT.Client.exceptions.InvalidAggregationException
• IoT.Client.exceptions.VersionConflictException
• IoT.Client.exceptions.IndexNotReadyException