Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.LookoutEquipment.CreateLabel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a label for an event.

Synopsis

data CreateLabel = CreateLabel' {
- equipment :: Maybe Text
- faultCode :: Maybe Text
- notes :: Maybe Text
- labelGroupName :: Text
- startTime :: POSIX
- endTime :: POSIX
- rating :: LabelRating
- clientToken :: Text
}
newCreateLabel :: Text -> UTCTime -> UTCTime -> LabelRating -> Text -> CreateLabel
createLabel_equipment :: Lens' CreateLabel (Maybe Text)
createLabel_faultCode :: Lens' CreateLabel (Maybe Text)
createLabel_notes :: Lens' CreateLabel (Maybe Text)
createLabel_labelGroupName :: Lens' CreateLabel Text
createLabel_startTime :: Lens' CreateLabel UTCTime
createLabel_endTime :: Lens' CreateLabel UTCTime
createLabel_rating :: Lens' CreateLabel LabelRating
createLabel_clientToken :: Lens' CreateLabel Text
data CreateLabelResponse = CreateLabelResponse' {
- labelId :: Maybe Text
- httpStatus :: Int
}
newCreateLabelResponse :: Int -> CreateLabelResponse
createLabelResponse_labelId :: Lens' CreateLabelResponse (Maybe Text)
createLabelResponse_httpStatus :: Lens' CreateLabelResponse Int

Creating a Request

data CreateLabel Source #

See: newCreateLabel smart constructor.

Constructors

CreateLabel'

Fields

equipment :: Maybe Text
Indicates that a label pertains to a particular piece of equipment.
Data in this field will be retained for service usage. Follow best practices for the security of your data.
faultCode :: Maybe Text
Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.
Data in this field will be retained for service usage. Follow best practices for the security of your data.
notes :: Maybe Text
Metadata providing additional information about the label.
Data in this field will be retained for service usage. Follow best practices for the security of your data.
labelGroupName :: Text
The name of a group of labels.
Data in this field will be retained for service usage. Follow best practices for the security of your data.
startTime :: POSIX
The start time of the labeled event.
endTime :: POSIX
The end time of the labeled event.
rating :: LabelRating
Indicates whether a labeled event represents an anomaly.
clientToken :: Text
A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

Instances

Instances details

ToJSON CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods toJSON :: CreateLabel -> Value # toEncoding :: CreateLabel -> Encoding # toJSONList :: [CreateLabel] -> Value # toEncodingList :: [CreateLabel] -> Encoding #
ToHeaders CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods toHeaders :: CreateLabel -> [Header] #
ToPath CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods toPath :: CreateLabel -> ByteString #
ToQuery CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods toQuery :: CreateLabel -> QueryString #
AWSRequest CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Associated Types type AWSResponse CreateLabel # Methods request :: (Service -> Service) -> CreateLabel -> Request CreateLabel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateLabel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLabel))) #
Generic CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Associated Types type Rep CreateLabel :: Type -> Type # Methods from :: CreateLabel -> Rep CreateLabel x # to :: Rep CreateLabel x -> CreateLabel #
Read CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods readsPrec :: Int -> ReadS CreateLabel # readList :: ReadS [CreateLabel] # readPrec :: ReadPrec CreateLabel # readListPrec :: ReadPrec [CreateLabel] #
Show CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods showsPrec :: Int -> CreateLabel -> ShowS # show :: CreateLabel -> String # showList :: [CreateLabel] -> ShowS #
NFData CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods rnf :: CreateLabel -> () #
Eq CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods (==) :: CreateLabel -> CreateLabel -> Bool # (/=) :: CreateLabel -> CreateLabel -> Bool #
Hashable CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods hashWithSalt :: Int -> CreateLabel -> Int # hash :: CreateLabel -> Int #
type AWSResponse CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel type AWSResponse CreateLabel = CreateLabelResponse
type Rep CreateLabel Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel type Rep CreateLabel = D1 ('MetaData "CreateLabel" "Amazonka.LookoutEquipment.CreateLabel" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "CreateLabel'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "equipment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "faultCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "notes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "labelGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "rating") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LabelRating) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateLabel Source #

Arguments

:: Text	`CreateLabel`
-> UTCTime	`CreateLabel`
-> UTCTime	`CreateLabel`
-> LabelRating	`CreateLabel`
-> Text	`$sel:clientToken:CreateLabel'`
-> CreateLabel

Create a value of CreateLabel 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:

CreateLabel, createLabel_equipment - Indicates that a label pertains to a particular piece of equipment.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

CreateLabel, createLabel_faultCode - Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

$sel:notes:CreateLabel', createLabel_notes - Metadata providing additional information about the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

CreateLabel, createLabel_labelGroupName - The name of a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

CreateLabel, createLabel_startTime - The start time of the labeled event.

CreateLabel, createLabel_endTime - The end time of the labeled event.

CreateLabel, createLabel_rating - Indicates whether a labeled event represents an anomaly.

$sel:clientToken:CreateLabel', createLabel_clientToken - A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

Request Lenses

createLabel_equipment :: Lens' CreateLabel (Maybe Text) Source #

Indicates that a label pertains to a particular piece of equipment.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabel_faultCode :: Lens' CreateLabel (Maybe Text) Source #

Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabel_notes :: Lens' CreateLabel (Maybe Text) Source #

Metadata providing additional information about the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabel_labelGroupName :: Lens' CreateLabel Text Source #

The name of a group of labels.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

createLabel_startTime :: Lens' CreateLabel UTCTime Source #

The start time of the labeled event.

createLabel_endTime :: Lens' CreateLabel UTCTime Source #

The end time of the labeled event.

createLabel_rating :: Lens' CreateLabel LabelRating Source #

Indicates whether a labeled event represents an anomaly.

createLabel_clientToken :: Lens' CreateLabel Text Source #

A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

Destructuring the Response

data CreateLabelResponse Source #

See: newCreateLabelResponse smart constructor.

Constructors

CreateLabelResponse'
Fields labelId :: Maybe Text The ID of the label that you have created. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateLabelResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Associated Types type Rep CreateLabelResponse :: Type -> Type # Methods from :: CreateLabelResponse -> Rep CreateLabelResponse x # to :: Rep CreateLabelResponse x -> CreateLabelResponse #
Read CreateLabelResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods readsPrec :: Int -> ReadS CreateLabelResponse # readList :: ReadS [CreateLabelResponse] # readPrec :: ReadPrec CreateLabelResponse # readListPrec :: ReadPrec [CreateLabelResponse] #
Show CreateLabelResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods showsPrec :: Int -> CreateLabelResponse -> ShowS # show :: CreateLabelResponse -> String # showList :: [CreateLabelResponse] -> ShowS #
NFData CreateLabelResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods rnf :: CreateLabelResponse -> () #
Eq CreateLabelResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel Methods (==) :: CreateLabelResponse -> CreateLabelResponse -> Bool # (/=) :: CreateLabelResponse -> CreateLabelResponse -> Bool #
type Rep CreateLabelResponse Source #
Instance details Defined in Amazonka.LookoutEquipment.CreateLabel type Rep CreateLabelResponse = D1 ('MetaData "CreateLabelResponse" "Amazonka.LookoutEquipment.CreateLabel" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "CreateLabelResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "labelId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLabelResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateLabelResponse'`
-> CreateLabelResponse

Create a value of CreateLabelResponse 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:

CreateLabelResponse, createLabelResponse_labelId - The ID of the label that you have created.

$sel:httpStatus:CreateLabelResponse', createLabelResponse_httpStatus - The response's http status code.

Response Lenses

createLabelResponse_labelId :: Lens' CreateLabelResponse (Maybe Text) Source #

The ID of the label that you have created.

createLabelResponse_httpStatus :: Lens' CreateLabelResponse Int Source #

The response's http status code.