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.DescribeLabel

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the name of the label.

Synopsis

data DescribeLabel = DescribeLabel' {
- labelGroupName :: Text
- labelId :: Text
}
newDescribeLabel :: Text -> Text -> DescribeLabel
describeLabel_labelGroupName :: Lens' DescribeLabel Text
describeLabel_labelId :: Lens' DescribeLabel Text
data DescribeLabelResponse = DescribeLabelResponse' {
- createdAt :: Maybe POSIX
- endTime :: Maybe POSIX
- equipment :: Maybe Text
- faultCode :: Maybe Text
- labelGroupArn :: Maybe Text
- labelGroupName :: Maybe Text
- labelId :: Maybe Text
- notes :: Maybe Text
- rating :: Maybe LabelRating
- startTime :: Maybe POSIX
- httpStatus :: Int
}
newDescribeLabelResponse :: Int -> DescribeLabelResponse
describeLabelResponse_createdAt :: Lens' DescribeLabelResponse (Maybe UTCTime)
describeLabelResponse_endTime :: Lens' DescribeLabelResponse (Maybe UTCTime)
describeLabelResponse_equipment :: Lens' DescribeLabelResponse (Maybe Text)
describeLabelResponse_faultCode :: Lens' DescribeLabelResponse (Maybe Text)
describeLabelResponse_labelGroupArn :: Lens' DescribeLabelResponse (Maybe Text)
describeLabelResponse_labelGroupName :: Lens' DescribeLabelResponse (Maybe Text)
describeLabelResponse_labelId :: Lens' DescribeLabelResponse (Maybe Text)
describeLabelResponse_notes :: Lens' DescribeLabelResponse (Maybe Text)
describeLabelResponse_rating :: Lens' DescribeLabelResponse (Maybe LabelRating)
describeLabelResponse_startTime :: Lens' DescribeLabelResponse (Maybe UTCTime)
describeLabelResponse_httpStatus :: Lens' DescribeLabelResponse Int

Creating a Request

data DescribeLabel Source #

See: newDescribeLabel smart constructor.

Constructors

DescribeLabel'
Fields labelGroupName :: Text Returns the name of the group containing the label. labelId :: Text Returns the ID of the label.

Instances

Instances details

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

newDescribeLabel Source #

Arguments

:: Text	`DescribeLabel`
-> Text	`DescribeLabel`
-> DescribeLabel

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

DescribeLabel, describeLabel_labelGroupName - Returns the name of the group containing the label.

DescribeLabel, describeLabel_labelId - Returns the ID of the label.

Request Lenses

describeLabel_labelGroupName :: Lens' DescribeLabel Text Source #

Returns the name of the group containing the label.

describeLabel_labelId :: Lens' DescribeLabel Text Source #

Returns the ID of the label.

Destructuring the Response

data DescribeLabelResponse Source #

See: newDescribeLabelResponse smart constructor.

Constructors

DescribeLabelResponse'

Fields

createdAt :: Maybe POSIX
The time at which the label was created.
endTime :: Maybe POSIX
The end time of the requested label.
equipment :: Maybe Text
Indicates that a label pertains to a particular piece of equipment.
faultCode :: Maybe Text
Indicates the type of anomaly associated with the label.
Data in this field will be retained for service usage. Follow best practices for the security of your data.
labelGroupArn :: Maybe Text
The ARN of the requested label group.
labelGroupName :: Maybe Text
The name of the requested label group.
labelId :: Maybe Text
The ID of the requested label.
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.
rating :: Maybe LabelRating
Indicates whether a labeled event represents an anomaly.
startTime :: Maybe POSIX
The start time of the requested label.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeLabelResponse Source #

Arguments

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

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

DescribeLabelResponse, describeLabelResponse_createdAt - The time at which the label was created.

DescribeLabelResponse, describeLabelResponse_endTime - The end time of the requested label.

DescribeLabelResponse, describeLabelResponse_equipment - Indicates that a label pertains to a particular piece of equipment.

DescribeLabelResponse, describeLabelResponse_faultCode - Indicates the type of anomaly associated with the label.

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

DescribeLabelResponse, describeLabelResponse_labelGroupArn - The ARN of the requested label group.

DescribeLabel, describeLabelResponse_labelGroupName - The name of the requested label group.

DescribeLabel, describeLabelResponse_labelId - The ID of the requested label.

$sel:notes:DescribeLabelResponse', describeLabelResponse_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.

DescribeLabelResponse, describeLabelResponse_rating - Indicates whether a labeled event represents an anomaly.

DescribeLabelResponse, describeLabelResponse_startTime - The start time of the requested label.

$sel:httpStatus:DescribeLabelResponse', describeLabelResponse_httpStatus - The response's http status code.

Response Lenses

describeLabelResponse_createdAt :: Lens' DescribeLabelResponse (Maybe UTCTime) Source #

The time at which the label was created.

describeLabelResponse_endTime :: Lens' DescribeLabelResponse (Maybe UTCTime) Source #

The end time of the requested label.

describeLabelResponse_equipment :: Lens' DescribeLabelResponse (Maybe Text) Source #

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

describeLabelResponse_faultCode :: Lens' DescribeLabelResponse (Maybe Text) Source #

Indicates the type of anomaly associated with the label.

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

describeLabelResponse_labelGroupArn :: Lens' DescribeLabelResponse (Maybe Text) Source #

The ARN of the requested label group.

describeLabelResponse_labelGroupName :: Lens' DescribeLabelResponse (Maybe Text) Source #

The name of the requested label group.

describeLabelResponse_labelId :: Lens' DescribeLabelResponse (Maybe Text) Source #

The ID of the requested label.

describeLabelResponse_notes :: Lens' DescribeLabelResponse (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.

describeLabelResponse_rating :: Lens' DescribeLabelResponse (Maybe LabelRating) Source #

Indicates whether a labeled event represents an anomaly.

describeLabelResponse_startTime :: Lens' DescribeLabelResponse (Maybe UTCTime) Source #

The start time of the requested label.

describeLabelResponse_httpStatus :: Lens' DescribeLabelResponse Int Source #

The response's http status code.