libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.ListThingGroups

Description

List the thing groups in your account.

Requires permission to access the ListThingGroups action.

This operation returns paginated results.

Synopsis

Creating a Request

data ListThingGroups Source #

See: newListThingGroups smart constructor.

Constructors

ListThingGroups' 

Fields

Instances

Instances details
Eq ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Read ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Show ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Generic ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Associated Types

type Rep ListThingGroups :: Type -> Type #

NFData ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Methods

rnf :: ListThingGroups -> () #

Hashable ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

AWSPager ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

AWSRequest ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Associated Types

type AWSResponse ListThingGroups #

ToHeaders ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

ToPath ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

ToQuery ListThingGroups Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

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

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

Instances

Instances details
Eq ListThingGroupsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Read ListThingGroupsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Show ListThingGroupsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Generic ListThingGroupsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListThingGroups

Associated Types

type Rep ListThingGroupsResponse :: Type -> Type #

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 #

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