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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a list of labels.

Synopsis

data ListLabels = ListLabels' {
- equipment :: Maybe Text
- faultCode :: Maybe Text
- intervalEndTime :: Maybe POSIX
- intervalStartTime :: Maybe POSIX
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- labelGroupName :: Text
}
newListLabels :: Text -> ListLabels
listLabels_equipment :: Lens' ListLabels (Maybe Text)
listLabels_faultCode :: Lens' ListLabels (Maybe Text)
listLabels_intervalEndTime :: Lens' ListLabels (Maybe UTCTime)
listLabels_intervalStartTime :: Lens' ListLabels (Maybe UTCTime)
listLabels_maxResults :: Lens' ListLabels (Maybe Natural)
listLabels_nextToken :: Lens' ListLabels (Maybe Text)
listLabels_labelGroupName :: Lens' ListLabels Text
data ListLabelsResponse = ListLabelsResponse' {
- labelSummaries :: Maybe [LabelSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListLabelsResponse :: Int -> ListLabelsResponse
listLabelsResponse_labelSummaries :: Lens' ListLabelsResponse (Maybe [LabelSummary])
listLabelsResponse_nextToken :: Lens' ListLabelsResponse (Maybe Text)
listLabelsResponse_httpStatus :: Lens' ListLabelsResponse Int

Creating a Request

data ListLabels Source #

See: newListLabels smart constructor.

Constructors

ListLabels'

Fields

equipment :: Maybe Text
Lists the labels that pertain to a particular piece of equipment.
faultCode :: Maybe Text
Returns labels with a particular fault code.
intervalEndTime :: Maybe POSIX
Returns all labels with a start time earlier than the end time given.
intervalStartTime :: Maybe POSIX
Returns all the labels with a end time equal to or later than the start time given.
maxResults :: Maybe Natural
Specifies the maximum number of labels to list.
nextToken :: Maybe Text
An opaque pagination token indicating where to continue the listing of label groups.
labelGroupName :: Text
Retruns the name of the label group.

Instances

Instances details

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

newListLabels Source #

Arguments

:: Text	`ListLabels`
-> ListLabels

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

ListLabels, listLabels_equipment - Lists the labels that pertain to a particular piece of equipment.

ListLabels, listLabels_faultCode - Returns labels with a particular fault code.

$sel:intervalEndTime:ListLabels', listLabels_intervalEndTime - Returns all labels with a start time earlier than the end time given.

$sel:intervalStartTime:ListLabels', listLabels_intervalStartTime - Returns all the labels with a end time equal to or later than the start time given.

$sel:maxResults:ListLabels', listLabels_maxResults - Specifies the maximum number of labels to list.

ListLabels, listLabels_nextToken - An opaque pagination token indicating where to continue the listing of label groups.

ListLabels, listLabels_labelGroupName - Retruns the name of the label group.

Request Lenses

listLabels_equipment :: Lens' ListLabels (Maybe Text) Source #

Lists the labels that pertain to a particular piece of equipment.

listLabels_faultCode :: Lens' ListLabels (Maybe Text) Source #

Returns labels with a particular fault code.

listLabels_intervalEndTime :: Lens' ListLabels (Maybe UTCTime) Source #

Returns all labels with a start time earlier than the end time given.

listLabels_intervalStartTime :: Lens' ListLabels (Maybe UTCTime) Source #

Returns all the labels with a end time equal to or later than the start time given.

listLabels_maxResults :: Lens' ListLabels (Maybe Natural) Source #

Specifies the maximum number of labels to list.

listLabels_nextToken :: Lens' ListLabels (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of label groups.

listLabels_labelGroupName :: Lens' ListLabels Text Source #

Retruns the name of the label group.

Destructuring the Response

data ListLabelsResponse Source #

See: newListLabelsResponse smart constructor.

Constructors

ListLabelsResponse'
Fields labelSummaries :: Maybe [LabelSummary] A summary of the items in the label group. nextToken :: Maybe Text An opaque pagination token indicating where to continue the listing of datasets. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListLabelsResponse Source #

Arguments

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

Create a value of ListLabelsResponse 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:labelSummaries:ListLabelsResponse', listLabelsResponse_labelSummaries - A summary of the items in the label group.

ListLabels, listLabelsResponse_nextToken - An opaque pagination token indicating where to continue the listing of datasets.

$sel:httpStatus:ListLabelsResponse', listLabelsResponse_httpStatus - The response's http status code.

Response Lenses

listLabelsResponse_labelSummaries :: Lens' ListLabelsResponse (Maybe [LabelSummary]) Source #

A summary of the items in the label group.

listLabelsResponse_nextToken :: Lens' ListLabelsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of datasets.

listLabelsResponse_httpStatus :: Lens' ListLabelsResponse Int Source #

The response's http status code.