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.CodeBuild.ListReportGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data ListReportGroups = ListReportGroups' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe ReportGroupSortByType
- sortOrder :: Maybe SortOrderType
}
newListReportGroups :: ListReportGroups
listReportGroups_maxResults :: Lens' ListReportGroups (Maybe Natural)
listReportGroups_nextToken :: Lens' ListReportGroups (Maybe Text)
listReportGroups_sortBy :: Lens' ListReportGroups (Maybe ReportGroupSortByType)
listReportGroups_sortOrder :: Lens' ListReportGroups (Maybe SortOrderType)
data ListReportGroupsResponse = ListReportGroupsResponse' {
- nextToken :: Maybe Text
- reportGroups :: Maybe (NonEmpty Text)
- httpStatus :: Int
}
newListReportGroupsResponse :: Int -> ListReportGroupsResponse
listReportGroupsResponse_nextToken :: Lens' ListReportGroupsResponse (Maybe Text)
listReportGroupsResponse_reportGroups :: Lens' ListReportGroupsResponse (Maybe (NonEmpty Text))
listReportGroupsResponse_httpStatus :: Lens' ListReportGroupsResponse Int

Creating a Request

data ListReportGroups Source #

See: newListReportGroups smart constructor.

Constructors

ListReportGroups'

Fields

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.
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.
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.
sortOrder :: Maybe SortOrderType
Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

Instances

Instances details

ToJSON ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods toJSON :: ListReportGroups -> Value # toEncoding :: ListReportGroups -> Encoding # toJSONList :: [ListReportGroups] -> Value # toEncodingList :: [ListReportGroups] -> Encoding #
ToHeaders ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods toHeaders :: ListReportGroups -> [Header] #
ToPath ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods toPath :: ListReportGroups -> ByteString #
ToQuery ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods toQuery :: ListReportGroups -> QueryString #
AWSPager ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods page :: ListReportGroups -> AWSResponse ListReportGroups -> Maybe ListReportGroups #
AWSRequest ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Associated Types type AWSResponse ListReportGroups # Methods request :: (Service -> Service) -> ListReportGroups -> Request ListReportGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListReportGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListReportGroups))) #
Generic ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Associated Types type Rep ListReportGroups :: Type -> Type # Methods from :: ListReportGroups -> Rep ListReportGroups x # to :: Rep ListReportGroups x -> ListReportGroups #
Read ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods readsPrec :: Int -> ReadS ListReportGroups # readList :: ReadS [ListReportGroups] # readPrec :: ReadPrec ListReportGroups # readListPrec :: ReadPrec [ListReportGroups] #
Show ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods showsPrec :: Int -> ListReportGroups -> ShowS # show :: ListReportGroups -> String # showList :: [ListReportGroups] -> ShowS #
NFData ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods rnf :: ListReportGroups -> () #
Eq ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods (==) :: ListReportGroups -> ListReportGroups -> Bool # (/=) :: ListReportGroups -> ListReportGroups -> Bool #
Hashable ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods hashWithSalt :: Int -> ListReportGroups -> Int # hash :: ListReportGroups -> Int #
type AWSResponse ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups type AWSResponse ListReportGroups = ListReportGroupsResponse
type Rep ListReportGroups Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups type Rep ListReportGroups = D1 ('MetaData "ListReportGroups" "Amazonka.CodeBuild.ListReportGroups" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "ListReportGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportGroupSortByType)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrderType)))))

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

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

$sel:sortOrder:ListReportGroups', listReportGroups_sortOrder - Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

Request Lenses

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

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.

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

Generic ListReportGroupsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Associated Types type Rep ListReportGroupsResponse :: Type -> Type # Methods from :: ListReportGroupsResponse -> Rep ListReportGroupsResponse x # to :: Rep ListReportGroupsResponse x -> ListReportGroupsResponse #
Read ListReportGroupsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods readsPrec :: Int -> ReadS ListReportGroupsResponse # readList :: ReadS [ListReportGroupsResponse] # readPrec :: ReadPrec ListReportGroupsResponse # readListPrec :: ReadPrec [ListReportGroupsResponse] #
Show ListReportGroupsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods showsPrec :: Int -> ListReportGroupsResponse -> ShowS # show :: ListReportGroupsResponse -> String # showList :: [ListReportGroupsResponse] -> ShowS #
NFData ListReportGroupsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods rnf :: ListReportGroupsResponse -> () #
Eq ListReportGroupsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups Methods (==) :: ListReportGroupsResponse -> ListReportGroupsResponse -> Bool # (/=) :: ListReportGroupsResponse -> ListReportGroupsResponse -> Bool #
type Rep ListReportGroupsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReportGroups type Rep ListReportGroupsResponse = D1 ('MetaData "ListReportGroupsResponse" "Amazonka.CodeBuild.ListReportGroups" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" '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 #

Arguments

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

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:

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.

listReportGroupsResponse_httpStatus :: Lens' ListReportGroupsResponse Int Source #

The response's http status code.