AWSIoTCreateCustomMetricRequest

Objective-C

@interface AWSIoTCreateCustomMetricRequest

Swift

class AWSIoTCreateCustomMetricRequest

  • Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientRequestToken;

    Swift

    var clientRequestToken: String? { get set }

  • The friendly name in the console for the custom metric. This name doesn’t have to be unique. Don’t use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable displayName;

    Swift

    var displayName: String? { get set }

  • The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can’t begin with aws:. You can’t change the name after you define it.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable metricName;

    Swift

    var metricName: String? { get set }

  • The type of the custom metric.

    The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

    Declaration

    Objective-C

    @property (nonatomic) AWSIoTCustomMetricType metricType;

    Swift

    var metricType: AWSIoTCustomMetricType { get set }

  • Metadata that can be used to manage the custom metric.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSIoTTag *> *_Nullable tags;

    Swift

    var tags: [AWSIoTTag]? { get set }