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 }

  • Field represents a friendly name in the console for the custom metric; it doesn’t have to be unique. Don’t use this name as the metric identifier in the device metric report. Can be updated once defined.

    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. Shouldn’t begin with aws:. Cannot be updated once defined.

    Declaration

    Objective-C

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

    Swift

    var metricName: String? { get set }

  • The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

    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 }