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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the billing groups you have created.

Requires permission to access the ListBillingGroups action.

This operation returns paginated results.

Synopsis

data ListBillingGroups = ListBillingGroups' {
- maxResults :: Maybe Natural
- namePrefixFilter :: Maybe Text
- nextToken :: Maybe Text
}
newListBillingGroups :: ListBillingGroups
listBillingGroups_maxResults :: Lens' ListBillingGroups (Maybe Natural)
listBillingGroups_namePrefixFilter :: Lens' ListBillingGroups (Maybe Text)
listBillingGroups_nextToken :: Lens' ListBillingGroups (Maybe Text)
data ListBillingGroupsResponse = ListBillingGroupsResponse' {
- billingGroups :: Maybe [GroupNameAndArn]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListBillingGroupsResponse :: Int -> ListBillingGroupsResponse
listBillingGroupsResponse_billingGroups :: Lens' ListBillingGroupsResponse (Maybe [GroupNameAndArn])
listBillingGroupsResponse_nextToken :: Lens' ListBillingGroupsResponse (Maybe Text)
listBillingGroupsResponse_httpStatus :: Lens' ListBillingGroupsResponse Int

Creating a Request

data ListBillingGroups Source #

See: newListBillingGroups smart constructor.

Constructors

ListBillingGroups'
Fields maxResults :: Maybe Natural The maximum number of results to return per request. namePrefixFilter :: Maybe Text Limit the results to billing groups whose names have the given 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.

Instances

Instances details

ToHeaders ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods toHeaders :: ListBillingGroups -> [Header] #
ToPath ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods toPath :: ListBillingGroups -> ByteString #
ToQuery ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods toQuery :: ListBillingGroups -> QueryString #
AWSPager ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods page :: ListBillingGroups -> AWSResponse ListBillingGroups -> Maybe ListBillingGroups #
AWSRequest ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Associated Types type AWSResponse ListBillingGroups # Methods request :: (Service -> Service) -> ListBillingGroups -> Request ListBillingGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListBillingGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListBillingGroups))) #
Generic ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Associated Types type Rep ListBillingGroups :: Type -> Type # Methods from :: ListBillingGroups -> Rep ListBillingGroups x # to :: Rep ListBillingGroups x -> ListBillingGroups #
Read ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods readsPrec :: Int -> ReadS ListBillingGroups # readList :: ReadS [ListBillingGroups] # readPrec :: ReadPrec ListBillingGroups # readListPrec :: ReadPrec [ListBillingGroups] #
Show ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods showsPrec :: Int -> ListBillingGroups -> ShowS # show :: ListBillingGroups -> String # showList :: [ListBillingGroups] -> ShowS #
NFData ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods rnf :: ListBillingGroups -> () #
Eq ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods (==) :: ListBillingGroups -> ListBillingGroups -> Bool # (/=) :: ListBillingGroups -> ListBillingGroups -> Bool #
Hashable ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods hashWithSalt :: Int -> ListBillingGroups -> Int # hash :: ListBillingGroups -> Int #
type AWSResponse ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups type AWSResponse ListBillingGroups = ListBillingGroupsResponse
type Rep ListBillingGroups Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups type Rep ListBillingGroups = D1 ('MetaData "ListBillingGroups" "Amazonka.IoT.ListBillingGroups" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListBillingGroups'" '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)))))

newListBillingGroups :: ListBillingGroups Source #

Create a value of ListBillingGroups 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:ListBillingGroups', listBillingGroups_maxResults - The maximum number of results to return per request.

$sel:namePrefixFilter:ListBillingGroups', listBillingGroups_namePrefixFilter - Limit the results to billing groups whose names have the given prefix.

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

Request Lenses

listBillingGroups_maxResults :: Lens' ListBillingGroups (Maybe Natural) Source #

The maximum number of results to return per request.

listBillingGroups_namePrefixFilter :: Lens' ListBillingGroups (Maybe Text) Source #

Limit the results to billing groups whose names have the given prefix.

listBillingGroups_nextToken :: Lens' ListBillingGroups (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.

Destructuring the Response

data ListBillingGroupsResponse Source #

See: newListBillingGroupsResponse smart constructor.

Constructors

ListBillingGroupsResponse'
Fields billingGroups :: Maybe [GroupNameAndArn] The list of billing groups. nextToken :: Maybe Text The token to use to get the next set of results, or null if there are no additional results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListBillingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Associated Types type Rep ListBillingGroupsResponse :: Type -> Type # Methods from :: ListBillingGroupsResponse -> Rep ListBillingGroupsResponse x # to :: Rep ListBillingGroupsResponse x -> ListBillingGroupsResponse #
Read ListBillingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods readsPrec :: Int -> ReadS ListBillingGroupsResponse # readList :: ReadS [ListBillingGroupsResponse] # readPrec :: ReadPrec ListBillingGroupsResponse # readListPrec :: ReadPrec [ListBillingGroupsResponse] #
Show ListBillingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods showsPrec :: Int -> ListBillingGroupsResponse -> ShowS # show :: ListBillingGroupsResponse -> String # showList :: [ListBillingGroupsResponse] -> ShowS #
NFData ListBillingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods rnf :: ListBillingGroupsResponse -> () #
Eq ListBillingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups Methods (==) :: ListBillingGroupsResponse -> ListBillingGroupsResponse -> Bool # (/=) :: ListBillingGroupsResponse -> ListBillingGroupsResponse -> Bool #
type Rep ListBillingGroupsResponse Source #
Instance details Defined in Amazonka.IoT.ListBillingGroups type Rep ListBillingGroupsResponse = D1 ('MetaData "ListBillingGroupsResponse" "Amazonka.IoT.ListBillingGroups" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListBillingGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "billingGroups") '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))))

newListBillingGroupsResponse Source #

Arguments

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

Create a value of ListBillingGroupsResponse 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:billingGroups:ListBillingGroupsResponse', listBillingGroupsResponse_billingGroups - The list of billing groups.

ListBillingGroups, listBillingGroupsResponse_nextToken - The token to use to get the next set of results, or null if there are no additional results.

$sel:httpStatus:ListBillingGroupsResponse', listBillingGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listBillingGroupsResponse_billingGroups :: Lens' ListBillingGroupsResponse (Maybe [GroupNameAndArn]) Source #

The list of billing groups.

listBillingGroupsResponse_nextToken :: Lens' ListBillingGroupsResponse (Maybe Text) Source #

The token to use to get the next set of results, or null if there are no additional results.

listBillingGroupsResponse_httpStatus :: Lens' ListBillingGroupsResponse Int Source #

The response's http status code.