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.CodeGuruProfiler.ListProfilingGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

Synopsis

Creating a Request

data ListProfilingGroups Source #

The structure representing the listProfilingGroupsRequest.

See: newListProfilingGroups smart constructor.

Constructors

ListProfilingGroups'

Fields

includeDescription :: Maybe Bool
A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.
maxResults :: Maybe Natural
The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.
nextToken :: Maybe Text
The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Instances

Instances details

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

newListProfilingGroups :: ListProfilingGroups Source #

Create a value of ListProfilingGroups 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:includeDescription:ListProfilingGroups', listProfilingGroups_includeDescription - A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

$sel:maxResults:ListProfilingGroups', listProfilingGroups_maxResults - The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.

ListProfilingGroups, listProfilingGroups_nextToken - The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Request Lenses

listProfilingGroups_includeDescription :: Lens' ListProfilingGroups (Maybe Bool) Source #

A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

listProfilingGroups_maxResults :: Lens' ListProfilingGroups (Maybe Natural) Source #

The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.

listProfilingGroups_nextToken :: Lens' ListProfilingGroups (Maybe Text) Source #

The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Destructuring the Response

data ListProfilingGroupsResponse Source #

The structure representing the listProfilingGroupsResponse.

See: newListProfilingGroupsResponse smart constructor.

Constructors

ListProfilingGroupsResponse'

Fields

nextToken :: Maybe Text
The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
profilingGroups :: Maybe [ProfilingGroupDescription]
A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned.
httpStatus :: Int
The response's http status code.
profilingGroupNames :: [Text]
A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned.

Instances

Instances details

Generic ListProfilingGroupsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups Associated Types type Rep ListProfilingGroupsResponse :: Type -> Type # Methods from :: ListProfilingGroupsResponse -> Rep ListProfilingGroupsResponse x # to :: Rep ListProfilingGroupsResponse x -> ListProfilingGroupsResponse #
Read ListProfilingGroupsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups Methods readsPrec :: Int -> ReadS ListProfilingGroupsResponse # readList :: ReadS [ListProfilingGroupsResponse] # readPrec :: ReadPrec ListProfilingGroupsResponse # readListPrec :: ReadPrec [ListProfilingGroupsResponse] #
Show ListProfilingGroupsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups Methods showsPrec :: Int -> ListProfilingGroupsResponse -> ShowS # show :: ListProfilingGroupsResponse -> String # showList :: [ListProfilingGroupsResponse] -> ShowS #
NFData ListProfilingGroupsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups Methods rnf :: ListProfilingGroupsResponse -> () #
Eq ListProfilingGroupsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups Methods (==) :: ListProfilingGroupsResponse -> ListProfilingGroupsResponse -> Bool # (/=) :: ListProfilingGroupsResponse -> ListProfilingGroupsResponse -> Bool #
type Rep ListProfilingGroupsResponse Source #
Instance details Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups type Rep ListProfilingGroupsResponse = D1 ('MetaData "ListProfilingGroupsResponse" "Amazonka.CodeGuruProfiler.ListProfilingGroups" "amazonka-codeguruprofiler-2.0-DsjyOqDx8Zb8uCUpe33U62" 'False) (C1 ('MetaCons "ListProfilingGroupsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "profilingGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ProfilingGroupDescription]))) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "profilingGroupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newListProfilingGroupsResponse Source #

Arguments

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

Create a value of ListProfilingGroupsResponse 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:

ListProfilingGroups, listProfilingGroupsResponse_nextToken - The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

$sel:profilingGroups:ListProfilingGroupsResponse', listProfilingGroupsResponse_profilingGroups - A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned.

$sel:httpStatus:ListProfilingGroupsResponse', listProfilingGroupsResponse_httpStatus - The response's http status code.

$sel:profilingGroupNames:ListProfilingGroupsResponse', listProfilingGroupsResponse_profilingGroupNames - A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned.

Response Lenses

listProfilingGroupsResponse_nextToken :: Lens' ListProfilingGroupsResponse (Maybe Text) Source #

The nextToken value to include in a future ListProfilingGroups request. When the results of a ListProfilingGroups request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

listProfilingGroupsResponse_profilingGroups :: Lens' ListProfilingGroupsResponse (Maybe [ProfilingGroupDescription]) Source #

A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned.

listProfilingGroupsResponse_httpStatus :: Lens' ListProfilingGroupsResponse Int Source #

The response's http status code.

listProfilingGroupsResponse_profilingGroupNames :: Lens' ListProfilingGroupsResponse [Text] Source #

A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned.