libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.UpdateCustomMetric

Description

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

Synopsis

Creating a Request

data UpdateCustomMetric Source #

See: newUpdateCustomMetric smart constructor.

Constructors

UpdateCustomMetric' 

Fields

  • metricName :: Text

    The name of the custom metric. Cannot be updated.

  • displayName :: Text

    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.

Instances

Instances details
Eq UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Read UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Show UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Generic UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Associated Types

type Rep UpdateCustomMetric :: Type -> Type #

NFData UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Methods

rnf :: UpdateCustomMetric -> () #

Hashable UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

ToJSON UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

AWSRequest UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Associated Types

type AWSResponse UpdateCustomMetric #

ToHeaders UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

ToPath UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

ToQuery UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

type Rep UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

type Rep UpdateCustomMetric = D1 ('MetaData "UpdateCustomMetric" "Amazonka.IoT.UpdateCustomMetric" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateCustomMetric'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse UpdateCustomMetric Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

newUpdateCustomMetric Source #

Create a value of UpdateCustomMetric with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metricName:UpdateCustomMetric', updateCustomMetric_metricName - The name of the custom metric. Cannot be updated.

$sel:displayName:UpdateCustomMetric', updateCustomMetric_displayName - 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.

Request Lenses

updateCustomMetric_metricName :: Lens' UpdateCustomMetric Text Source #

The name of the custom metric. Cannot be updated.

updateCustomMetric_displayName :: Lens' UpdateCustomMetric Text Source #

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.

Destructuring the Response

data UpdateCustomMetricResponse Source #

See: newUpdateCustomMetricResponse smart constructor.

Constructors

UpdateCustomMetricResponse' 

Fields

Instances

Instances details
Eq UpdateCustomMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Read UpdateCustomMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Show UpdateCustomMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Generic UpdateCustomMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

Associated Types

type Rep UpdateCustomMetricResponse :: Type -> Type #

NFData UpdateCustomMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

type Rep UpdateCustomMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateCustomMetric

type Rep UpdateCustomMetricResponse = D1 ('MetaData "UpdateCustomMetricResponse" "Amazonka.IoT.UpdateCustomMetric" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateCustomMetricResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metricType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CustomMetricType)) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "metricArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newUpdateCustomMetricResponse Source #

Create a value of UpdateCustomMetricResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:metricType:UpdateCustomMetricResponse', updateCustomMetricResponse_metricType - The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

$sel:lastModifiedDate:UpdateCustomMetricResponse', updateCustomMetricResponse_lastModifiedDate - The time the custom metric was last modified in milliseconds since epoch.

$sel:metricName:UpdateCustomMetric', updateCustomMetricResponse_metricName - The name of the custom metric.

$sel:displayName:UpdateCustomMetric', updateCustomMetricResponse_displayName - A friendly name in the console for the custom metric

$sel:creationDate:UpdateCustomMetricResponse', updateCustomMetricResponse_creationDate - The creation date of the custom metric in milliseconds since epoch.

$sel:metricArn:UpdateCustomMetricResponse', updateCustomMetricResponse_metricArn - The Amazon Resource Number (ARN) of the custom metric.

$sel:httpStatus:UpdateCustomMetricResponse', updateCustomMetricResponse_httpStatus - The response's http status code.

Response Lenses

updateCustomMetricResponse_metricType :: Lens' UpdateCustomMetricResponse (Maybe CustomMetricType) Source #

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

updateCustomMetricResponse_lastModifiedDate :: Lens' UpdateCustomMetricResponse (Maybe UTCTime) Source #

The time the custom metric was last modified in milliseconds since epoch.

updateCustomMetricResponse_displayName :: Lens' UpdateCustomMetricResponse (Maybe Text) Source #

A friendly name in the console for the custom metric

updateCustomMetricResponse_creationDate :: Lens' UpdateCustomMetricResponse (Maybe UTCTime) Source #

The creation date of the custom metric in milliseconds since epoch.

updateCustomMetricResponse_metricArn :: Lens' UpdateCustomMetricResponse (Maybe Text) Source #

The Amazon Resource Number (ARN) of the custom metric.