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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List the thing groups in your account.

Requires permission to access the ListThingGroups action.

This operation returns paginated results.

Synopsis

data ListThingGroups = ListThingGroups' {
- namePrefixFilter :: Maybe Text
- parentGroup :: Maybe Text
- nextToken :: Maybe Text
- recursive :: Maybe Bool
- maxResults :: Maybe Natural
}
newListThingGroups :: ListThingGroups
listThingGroups_namePrefixFilter :: Lens' ListThingGroups (Maybe Text)
listThingGroups_parentGroup :: Lens' ListThingGroups (Maybe Text)
listThingGroups_nextToken :: Lens' ListThingGroups (Maybe Text)
listThingGroups_recursive :: Lens' ListThingGroups (Maybe Bool)
listThingGroups_maxResults :: Lens' ListThingGroups (Maybe Natural)
data ListThingGroupsResponse = ListThingGroupsResponse' {
- thingGroups :: Maybe [GroupNameAndArn]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListThingGroupsResponse :: Int -> ListThingGroupsResponse
listThingGroupsResponse_thingGroups :: Lens' ListThingGroupsResponse (Maybe [GroupNameAndArn])
listThingGroupsResponse_nextToken :: Lens' ListThingGroupsResponse (Maybe Text)
listThingGroupsResponse_httpStatus :: Lens' ListThingGroupsResponse Int

Creating a Request

data ListThingGroups Source #

See: newListThingGroups smart constructor.

Constructors

ListThingGroups'

Fields

namePrefixFilter :: Maybe Text
A filter that limits the results to those with the specified name prefix.
parentGroup :: Maybe Text
A filter that limits the results to those with the specified parent group.
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.
recursive :: Maybe Bool
If true, return child groups as well.
maxResults :: Maybe Natural
The maximum number of results to return at one time.

Instances

Instances details

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

newListThingGroups :: ListThingGroups Source #

Create a value of ListThingGroups 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:namePrefixFilter:ListThingGroups', listThingGroups_namePrefixFilter - A filter that limits the results to those with the specified name prefix.

$sel:parentGroup:ListThingGroups', listThingGroups_parentGroup - A filter that limits the results to those with the specified parent group.

$sel:nextToken:ListThingGroups', listThingGroups_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:recursive:ListThingGroups', listThingGroups_recursive - If true, return child groups as well.

$sel:maxResults:ListThingGroups', listThingGroups_maxResults - The maximum number of results to return at one time.

Request Lenses

listThingGroups_namePrefixFilter :: Lens' ListThingGroups (Maybe Text) Source #

A filter that limits the results to those with the specified name prefix.

listThingGroups_parentGroup :: Lens' ListThingGroups (Maybe Text) Source #

A filter that limits the results to those with the specified parent group.

listThingGroups_nextToken :: Lens' ListThingGroups (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.

listThingGroups_recursive :: Lens' ListThingGroups (Maybe Bool) Source #

If true, return child groups as well.

listThingGroups_maxResults :: Lens' ListThingGroups (Maybe Natural) Source #

The maximum number of results to return at one time.

Destructuring the Response

data ListThingGroupsResponse Source #

See: newListThingGroupsResponse smart constructor.

Constructors

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

Instances

Instances details

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

newListThingGroupsResponse Source #

Arguments

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

Create a value of ListThingGroupsResponse 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:thingGroups:ListThingGroupsResponse', listThingGroupsResponse_thingGroups - The thing groups.

$sel:nextToken:ListThingGroups', listThingGroupsResponse_nextToken - The token to use to get the next set of results. Will not be returned if operation has returned all results.

$sel:httpStatus:ListThingGroupsResponse', listThingGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listThingGroupsResponse_thingGroups :: Lens' ListThingGroupsResponse (Maybe [GroupNameAndArn]) Source #

The thing groups.

listThingGroupsResponse_nextToken :: Lens' ListThingGroupsResponse (Maybe Text) Source #

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

listThingGroupsResponse_httpStatus :: Lens' ListThingGroupsResponse Int Source #

The response's http status code.