libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler
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.CodeGuruProfiler.ListProfilingGroups

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.

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

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

Instances

Instances details
Eq ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Read ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Show ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Generic ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Associated Types

type Rep ListProfilingGroups :: Type -> Type #

NFData ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Methods

rnf :: ListProfilingGroups -> () #

Hashable ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

AWSRequest ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Associated Types

type AWSResponse ListProfilingGroups #

ToHeaders ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

ToPath ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

ToQuery ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

type Rep ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

type Rep ListProfilingGroups = D1 ('MetaData "ListProfilingGroups" "Amazonka.CodeGuruProfiler.ListProfilingGroups" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" 'False) (C1 ('MetaCons "ListProfilingGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListProfilingGroups Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

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:nextToken: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.

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

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

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.

Destructuring the Response

data ListProfilingGroupsResponse Source #

The structure representing the listProfilingGroupsResponse.

See: newListProfilingGroupsResponse smart constructor.

Constructors

ListProfilingGroupsResponse' 

Fields

Instances

Instances details
Eq ListProfilingGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Read ListProfilingGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Show ListProfilingGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Generic ListProfilingGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

Associated Types

type Rep ListProfilingGroupsResponse :: Type -> Type #

NFData ListProfilingGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

type Rep ListProfilingGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeGuruProfiler.ListProfilingGroups

type Rep ListProfilingGroupsResponse = D1 ('MetaData "ListProfilingGroupsResponse" "Amazonka.CodeGuruProfiler.ListProfilingGroups" "libZSservicesZSamazonka-codeguruprofilerZSamazonka-codeguruprofiler" '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 #

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:

$sel:nextToken: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_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.