libZSservicesZSamazonka-codebuildZSamazonka-codebuild
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.CodeBuild.ListReportGroups

Description

Gets a list ARNs for the report groups in the current Amazon Web Services account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListReportGroups Source #

See: newListReportGroups smart constructor.

Constructors

ListReportGroups' 

Fields

  • sortOrder :: Maybe SortOrderType

    Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

  • nextToken :: Maybe Text

    During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

  • maxResults :: Maybe Natural

    The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

  • sortBy :: Maybe ReportGroupSortByType

    The criterion to be used to list build report groups. Valid values include:

    • CREATED_TIME: List based on when each report group was created.
    • LAST_MODIFIED_TIME: List based on when each report group was last changed.
    • NAME: List based on each report group's name.

Instances

Instances details
Eq ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Read ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Show ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Generic ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Associated Types

type Rep ListReportGroups :: Type -> Type #

NFData ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Methods

rnf :: ListReportGroups -> () #

Hashable ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

ToJSON ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

AWSPager ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

AWSRequest ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Associated Types

type AWSResponse ListReportGroups #

ToHeaders ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

ToPath ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

ToQuery ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

type Rep ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

type Rep ListReportGroups = D1 ('MetaData "ListReportGroups" "Amazonka.CodeBuild.ListReportGroups" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "ListReportGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrderType)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportGroupSortByType)))))
type AWSResponse ListReportGroups Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

newListReportGroups :: ListReportGroups Source #

Create a value of ListReportGroups 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:sortOrder:ListReportGroups', listReportGroups_sortOrder - Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

$sel:nextToken:ListReportGroups', listReportGroups_nextToken - During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

$sel:maxResults:ListReportGroups', listReportGroups_maxResults - The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

$sel:sortBy:ListReportGroups', listReportGroups_sortBy - The criterion to be used to list build report groups. Valid values include:

  • CREATED_TIME: List based on when each report group was created.
  • LAST_MODIFIED_TIME: List based on when each report group was last changed.
  • NAME: List based on each report group's name.

Request Lenses

listReportGroups_sortOrder :: Lens' ListReportGroups (Maybe SortOrderType) Source #

Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

listReportGroups_nextToken :: Lens' ListReportGroups (Maybe Text) Source #

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

listReportGroups_maxResults :: Lens' ListReportGroups (Maybe Natural) Source #

The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

listReportGroups_sortBy :: Lens' ListReportGroups (Maybe ReportGroupSortByType) Source #

The criterion to be used to list build report groups. Valid values include:

  • CREATED_TIME: List based on when each report group was created.
  • LAST_MODIFIED_TIME: List based on when each report group was last changed.
  • NAME: List based on each report group's name.

Destructuring the Response

data ListReportGroupsResponse Source #

See: newListReportGroupsResponse smart constructor.

Constructors

ListReportGroupsResponse' 

Fields

  • nextToken :: Maybe Text

    During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

  • reportGroups :: Maybe (NonEmpty Text)

    The list of ARNs for the report groups in the current Amazon Web Services account.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq ListReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Read ListReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Show ListReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Generic ListReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

Associated Types

type Rep ListReportGroupsResponse :: Type -> Type #

NFData ListReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

type Rep ListReportGroupsResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.ListReportGroups

type Rep ListReportGroupsResponse = D1 ('MetaData "ListReportGroupsResponse" "Amazonka.CodeBuild.ListReportGroups" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "ListReportGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reportGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListReportGroupsResponse Source #

Create a value of ListReportGroupsResponse 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:ListReportGroups', listReportGroupsResponse_nextToken - During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

$sel:reportGroups:ListReportGroupsResponse', listReportGroupsResponse_reportGroups - The list of ARNs for the report groups in the current Amazon Web Services account.

$sel:httpStatus:ListReportGroupsResponse', listReportGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listReportGroupsResponse_nextToken :: Lens' ListReportGroupsResponse (Maybe Text) Source #

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

listReportGroupsResponse_reportGroups :: Lens' ListReportGroupsResponse (Maybe (NonEmpty Text)) Source #

The list of ARNs for the report groups in the current Amazon Web Services account.