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 |
Creates a label for an event.
Synopsis
- data CreateLabel = CreateLabel' {}
- 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.
CreateLabel' | |
|
Instances
:: Text | |
-> UTCTime | |
-> UTCTime | |
-> LabelRating | |
-> Text | |
-> 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.
CreateLabelResponse' | |
|
Instances
newCreateLabelResponse Source #
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.