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

Creating a Request

data ListThingGroups Source #

See: newListThingGroups smart constructor.

Constructors

ListThingGroups'

Fields

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

Instances

Instances details

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 #
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 :: (Service -> Service) -> ListThingGroups -> Request ListThingGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListThingGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListThingGroups))) #
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 #
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 #
NFData ListThingGroups Source #
Instance details Defined in Amazonka.IoT.ListThingGroups Methods rnf :: ListThingGroups -> () #
Eq ListThingGroups Source #
Instance details Defined in Amazonka.IoT.ListThingGroups Methods (==) :: ListThingGroups -> ListThingGroups -> Bool # (/=) :: ListThingGroups -> ListThingGroups -> Bool #
Hashable ListThingGroups Source #
Instance details Defined in Amazonka.IoT.ListThingGroups Methods hashWithSalt :: Int -> ListThingGroups -> Int # hash :: ListThingGroups -> Int #
type AWSResponse ListThingGroups Source #
Instance details Defined in Amazonka.IoT.ListThingGroups type AWSResponse ListThingGroups = ListThingGroupsResponse
type Rep ListThingGroups Source #
Instance details Defined in Amazonka.IoT.ListThingGroups type Rep ListThingGroups = D1 ('MetaData "ListThingGroups" "Amazonka.IoT.ListThingGroups" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListThingGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "namePrefixFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "parentGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "recursive") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

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:maxResults:ListThingGroups', listThingGroups_maxResults - The maximum number of results to return at one time.

$sel:namePrefixFilter:ListThingGroups', listThingGroups_namePrefixFilter - A filter that limits the results to those with the specified name prefix.

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:parentGroup:ListThingGroups', listThingGroups_parentGroup - A filter that limits the results to those with the specified parent group.

$sel:recursive:ListThingGroups', listThingGroups_recursive - If true, return child groups as well.

Request Lenses

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

The maximum number of results to return at one time.

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

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

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_parentGroup :: Lens' ListThingGroups (Maybe Text) Source #

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

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

If true, return child groups as well.

Destructuring the Response

data ListThingGroupsResponse Source #

See: newListThingGroupsResponse smart constructor.

Constructors

ListThingGroupsResponse'
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. thingGroups :: Maybe [GroupNameAndArn] The thing groups. httpStatus :: Int The response's http status code.

Instances

Instances details

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 #
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 #
NFData ListThingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingGroups Methods rnf :: ListThingGroupsResponse -> () #
Eq ListThingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingGroups Methods (==) :: ListThingGroupsResponse -> ListThingGroupsResponse -> Bool # (/=) :: ListThingGroupsResponse -> ListThingGroupsResponse -> Bool #
type Rep ListThingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListThingGroups type Rep ListThingGroupsResponse = D1 ('MetaData "ListThingGroupsResponse" "Amazonka.IoT.ListThingGroups" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListThingGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "thingGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupNameAndArn])) :: 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:

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

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

Response Lenses

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_thingGroups :: Lens' ListThingGroupsResponse (Maybe [GroupNameAndArn]) Source #

The thing groups.

listThingGroupsResponse_httpStatus :: Lens' ListThingGroupsResponse Int Source #

The response's http status code.