Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.ListThings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.

Requires permission to access the ListThings action.

You will not be charged for calling this API if an Access denied error is returned. You will also not be charged if no attributes or pagination token was provided in request and no pagination token and no results were returned.

This operation returns paginated results.

Synopsis

data ListThings = ListThings' {
- usePrefixAttributeValue :: Maybe Bool
- attributeValue :: Maybe Text
- thingTypeName :: Maybe Text
- nextToken :: Maybe Text
- attributeName :: Maybe Text
- maxResults :: Maybe Natural
}
newListThings :: ListThings
listThings_usePrefixAttributeValue :: Lens' ListThings (Maybe Bool)
listThings_attributeValue :: Lens' ListThings (Maybe Text)
listThings_thingTypeName :: Lens' ListThings (Maybe Text)
listThings_nextToken :: Lens' ListThings (Maybe Text)
listThings_attributeName :: Lens' ListThings (Maybe Text)
listThings_maxResults :: Lens' ListThings (Maybe Natural)
data ListThingsResponse = ListThingsResponse' {
- nextToken :: Maybe Text
- things :: Maybe [ThingAttribute]
- httpStatus :: Int
}
newListThingsResponse :: Int -> ListThingsResponse
listThingsResponse_nextToken :: Lens' ListThingsResponse (Maybe Text)
listThingsResponse_things :: Lens' ListThingsResponse (Maybe [ThingAttribute])
listThingsResponse_httpStatus :: Lens' ListThingsResponse Int

Creating a Request

data ListThings Source #

The input for the ListThings operation.

See: newListThings smart constructor.

Constructors

ListThings'

Fields

usePrefixAttributeValue :: Maybe Bool
When true, the action returns the thing resources with attribute values that start with the attributeValue provided.
When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.
attributeValue :: Maybe Text
The attribute value used to search for things.
thingTypeName :: Maybe Text
The name of the thing type used to search for things.
nextToken :: Maybe Text
To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
attributeName :: Maybe Text
The attribute name used to search for things.
maxResults :: Maybe Natural
The maximum number of results to return in this operation.

Instances

Instances details

Eq ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods (==) :: ListThings -> ListThings -> Bool # (/=) :: ListThings -> ListThings -> Bool #
Read ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods readsPrec :: Int -> ReadS ListThings # readList :: ReadS [ListThings] # readPrec :: ReadPrec ListThings # readListPrec :: ReadPrec [ListThings] #
Show ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods showsPrec :: Int -> ListThings -> ShowS # show :: ListThings -> String # showList :: [ListThings] -> ShowS #
Generic ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Associated Types type Rep ListThings :: Type -> Type # Methods from :: ListThings -> Rep ListThings x # to :: Rep ListThings x -> ListThings #
NFData ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods rnf :: ListThings -> () #
Hashable ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods hashWithSalt :: Int -> ListThings -> Int # hash :: ListThings -> Int #
AWSPager ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods page :: ListThings -> AWSResponse ListThings -> Maybe ListThings #
AWSRequest ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Associated Types type AWSResponse ListThings # Methods request :: ListThings -> Request ListThings # response :: MonadResource m => Logger -> Service -> Proxy ListThings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListThings))) #
ToHeaders ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods toHeaders :: ListThings -> [Header] #
ToPath ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods toPath :: ListThings -> ByteString #
ToQuery ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings Methods toQuery :: ListThings -> QueryString #
type Rep ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings type Rep ListThings = D1 ('MetaData "ListThings" "Amazonka.IoT.ListThings" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListThings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "usePrefixAttributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "thingTypeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "attributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))
type AWSResponse ListThings Source #
Instance details Defined in Amazonka.IoT.ListThings type AWSResponse ListThings = ListThingsResponse

newListThings :: ListThings Source #

Create a value of ListThings 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:usePrefixAttributeValue:ListThings', listThings_usePrefixAttributeValue - When true, the action returns the thing resources with attribute values that start with the attributeValue provided.

When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

$sel:attributeValue:ListThings', listThings_attributeValue - The attribute value used to search for things.

$sel:thingTypeName:ListThings', listThings_thingTypeName - The name of the thing type used to search for things.

$sel:nextToken:ListThings', listThings_nextToken - To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

$sel:attributeName:ListThings', listThings_attributeName - The attribute name used to search for things.

$sel:maxResults:ListThings', listThings_maxResults - The maximum number of results to return in this operation.

Request Lenses

listThings_usePrefixAttributeValue :: Lens' ListThings (Maybe Bool) Source #

When true, the action returns the thing resources with attribute values that start with the attributeValue provided.

When false, or not present, the action returns only the thing resources with attribute values that match the entire attributeValue provided.

listThings_attributeValue :: Lens' ListThings (Maybe Text) Source #

The attribute value used to search for things.

listThings_thingTypeName :: Lens' ListThings (Maybe Text) Source #

The name of the thing type used to search for things.

listThings_nextToken :: Lens' ListThings (Maybe Text) Source #

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

listThings_attributeName :: Lens' ListThings (Maybe Text) Source #

The attribute name used to search for things.

listThings_maxResults :: Lens' ListThings (Maybe Natural) Source #

The maximum number of results to return in this operation.

Destructuring the Response

data ListThingsResponse Source #

The output from the ListThings operation.

See: newListThingsResponse smart constructor.

Constructors

ListThingsResponse'
Fields nextToken :: Maybe Text The token to use to get the next set of results. Will not be returned if operation has returned all results. things :: Maybe [ThingAttribute] The things. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListThingsResponse Source #
Instance details Defined in Amazonka.IoT.ListThings Methods (==) :: ListThingsResponse -> ListThingsResponse -> Bool # (/=) :: ListThingsResponse -> ListThingsResponse -> Bool #
Read ListThingsResponse Source #
Instance details Defined in Amazonka.IoT.ListThings Methods readsPrec :: Int -> ReadS ListThingsResponse # readList :: ReadS [ListThingsResponse] # readPrec :: ReadPrec ListThingsResponse # readListPrec :: ReadPrec [ListThingsResponse] #
Show ListThingsResponse Source #
Instance details Defined in Amazonka.IoT.ListThings Methods showsPrec :: Int -> ListThingsResponse -> ShowS # show :: ListThingsResponse -> String # showList :: [ListThingsResponse] -> ShowS #
Generic ListThingsResponse Source #
Instance details Defined in Amazonka.IoT.ListThings Associated Types type Rep ListThingsResponse :: Type -> Type # Methods from :: ListThingsResponse -> Rep ListThingsResponse x # to :: Rep ListThingsResponse x -> ListThingsResponse #
NFData ListThingsResponse Source #
Instance details Defined in Amazonka.IoT.ListThings Methods rnf :: ListThingsResponse -> () #
type Rep ListThingsResponse Source #
Instance details Defined in Amazonka.IoT.ListThings type Rep ListThingsResponse = D1 ('MetaData "ListThingsResponse" "Amazonka.IoT.ListThings" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListThingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "things") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ThingAttribute])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListThingsResponse Source #

Arguments

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

Create a value of ListThingsResponse 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:nextToken:ListThings', listThingsResponse_nextToken - The token to use to get the next set of results. Will not be returned if operation has returned all results.

$sel:things:ListThingsResponse', listThingsResponse_things - The things.

$sel:httpStatus:ListThingsResponse', listThingsResponse_httpStatus - The response's http status code.

Response Lenses

listThingsResponse_nextToken :: Lens' ListThingsResponse (Maybe Text) Source #

The token to use to get the next set of results. Will not be returned if operation has returned all results.

listThingsResponse_things :: Lens' ListThingsResponse (Maybe [ThingAttribute]) Source #

The things.

listThingsResponse_httpStatus :: Lens' ListThingsResponse Int Source #

The response's http status code.