Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CodeBuild.ListReports

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of ARNs for the reports in the current Amazon Web Services account.

This operation returns paginated results.

Creating a Request

data ListReports Source #

See: newListReports smart constructor.

Constructors

ListReports'

Fields

sortOrder :: Maybe SortOrderType
Specifies the sort order for the list of returned reports. Valid values are:
- ASCENDING: return reports in chronological order based on their creation date.
- DESCENDING: return reports in the reverse chronological order based on their creation date.
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.
filter' :: Maybe ReportFilter
A ReportFilter object used to filter the returned reports.
maxResults :: Maybe Natural
The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

Instances

Instances details

Eq ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods (==) :: ListReports -> ListReports -> Bool # (/=) :: ListReports -> ListReports -> Bool #
Read ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods readsPrec :: Int -> ReadS ListReports # readList :: ReadS [ListReports] # readPrec :: ReadPrec ListReports # readListPrec :: ReadPrec [ListReports] #
Show ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods showsPrec :: Int -> ListReports -> ShowS # show :: ListReports -> String # showList :: [ListReports] -> ShowS #
Generic ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Associated Types type Rep ListReports :: Type -> Type # Methods from :: ListReports -> Rep ListReports x # to :: Rep ListReports x -> ListReports #
NFData ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods rnf :: ListReports -> () #
Hashable ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods hashWithSalt :: Int -> ListReports -> Int # hash :: ListReports -> Int #
ToJSON ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods toJSON :: ListReports -> Value # toEncoding :: ListReports -> Encoding # toJSONList :: [ListReports] -> Value # toEncodingList :: [ListReports] -> Encoding #
AWSPager ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods page :: ListReports -> AWSResponse ListReports -> Maybe ListReports #
AWSRequest ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Associated Types type AWSResponse ListReports # Methods request :: ListReports -> Request ListReports # response :: MonadResource m => Logger -> Service -> Proxy ListReports -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListReports))) #
ToHeaders ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods toHeaders :: ListReports -> [Header] #
ToPath ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods toPath :: ListReports -> ByteString #
ToQuery ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods toQuery :: ListReports -> QueryString #
type Rep ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports type Rep ListReports = D1 ('MetaData "ListReports" "Amazonka.CodeBuild.ListReports" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "ListReports'" '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 "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReportFilter)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListReports Source #
Instance details Defined in Amazonka.CodeBuild.ListReports type AWSResponse ListReports = ListReportsResponse

newListReports :: ListReports Source #

Create a value of ListReports 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:ListReports', listReports_sortOrder - Specifies the sort order for the list of returned reports. Valid values are:

ASCENDING: return reports in chronological order based on their creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.

$sel:nextToken:ListReports', listReports_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:filter':ListReports', listReports_filter - A ReportFilter object used to filter the returned reports.

$sel:maxResults:ListReports', listReports_maxResults - The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

Request Lenses

listReports_sortOrder :: Lens' ListReports (Maybe SortOrderType) Source #

Specifies the sort order for the list of returned reports. Valid values are:

ASCENDING: return reports in chronological order based on their creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.

listReports_nextToken :: Lens' ListReports (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.

listReports_filter :: Lens' ListReports (Maybe ReportFilter) Source #

A ReportFilter object used to filter the returned reports.

listReports_maxResults :: Lens' ListReports (Maybe Natural) Source #

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

Destructuring the Response

data ListReportsResponse Source #

See: newListReportsResponse smart constructor.

Constructors

ListReportsResponse'

Fields

reports :: Maybe (NonEmpty Text)
The list of returned ARNs for the reports in the current Amazon Web Services account.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListReportsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods (==) :: ListReportsResponse -> ListReportsResponse -> Bool # (/=) :: ListReportsResponse -> ListReportsResponse -> Bool #
Read ListReportsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods readsPrec :: Int -> ReadS ListReportsResponse # readList :: ReadS [ListReportsResponse] # readPrec :: ReadPrec ListReportsResponse # readListPrec :: ReadPrec [ListReportsResponse] #
Show ListReportsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods showsPrec :: Int -> ListReportsResponse -> ShowS # show :: ListReportsResponse -> String # showList :: [ListReportsResponse] -> ShowS #
Generic ListReportsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Associated Types type Rep ListReportsResponse :: Type -> Type # Methods from :: ListReportsResponse -> Rep ListReportsResponse x # to :: Rep ListReportsResponse x -> ListReportsResponse #
NFData ListReportsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReports Methods rnf :: ListReportsResponse -> () #
type Rep ListReportsResponse Source #
Instance details Defined in Amazonka.CodeBuild.ListReports type Rep ListReportsResponse = D1 ('MetaData "ListReportsResponse" "Amazonka.CodeBuild.ListReports" "libZSservicesZSamazonka-codebuildZSamazonka-codebuild" 'False) (C1 ('MetaCons "ListReportsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "reports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListReportsResponse Source #

Arguments

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

Create a value of ListReportsResponse 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:reports:ListReportsResponse', listReportsResponse_reports - The list of returned ARNs for the reports in the current Amazon Web Services account.

$sel:nextToken:ListReports', listReportsResponse_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:httpStatus:ListReportsResponse', listReportsResponse_httpStatus - The response's http status code.

Response Lenses

listReportsResponse_reports :: Lens' ListReportsResponse (Maybe (NonEmpty Text)) Source #

The list of returned ARNs for the reports in the current Amazon Web Services account.

listReportsResponse_nextToken :: Lens' ListReportsResponse (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.

listReportsResponse_httpStatus :: Lens' ListReportsResponse Int Source #

The response's http status code.