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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves one or more code coverage reports.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCodeCoverages Source #

See: newDescribeCodeCoverages smart constructor.

Constructors

DescribeCodeCoverages'

Fields

maxLineCoveragePercentage :: Maybe Double
The maximum line coverage percentage to report.
maxResults :: Maybe Natural
The maximum number of results to return.
minLineCoveragePercentage :: Maybe Double
The minimum line coverage percentage to report.
nextToken :: Maybe Text
The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.
sortBy :: Maybe ReportCodeCoverageSortByType
Specifies how the results are sorted. Possible values are:
FILE_PATH
The results are sorted by file path.
LINE_COVERAGE_PERCENTAGE
The results are sorted by the percentage of lines that are covered.
sortOrder :: Maybe SortOrderType
Specifies if the results are sorted in ascending or descending order.
reportArn :: Text
The ARN of the report for which test cases are returned.

Instances

Instances details

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

newDescribeCodeCoverages Source #

Arguments

:: Text	`DescribeCodeCoverages`
-> DescribeCodeCoverages

Create a value of DescribeCodeCoverages 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:maxLineCoveragePercentage:DescribeCodeCoverages', describeCodeCoverages_maxLineCoveragePercentage - The maximum line coverage percentage to report.

$sel:maxResults:DescribeCodeCoverages', describeCodeCoverages_maxResults - The maximum number of results to return.

$sel:minLineCoveragePercentage:DescribeCodeCoverages', describeCodeCoverages_minLineCoveragePercentage - The minimum line coverage percentage to report.

DescribeCodeCoverages, describeCodeCoverages_nextToken - The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

$sel:sortBy:DescribeCodeCoverages', describeCodeCoverages_sortBy - Specifies how the results are sorted. Possible values are:

FILE_PATH: The results are sorted by file path.
LINE_COVERAGE_PERCENTAGE: The results are sorted by the percentage of lines that are covered.

$sel:sortOrder:DescribeCodeCoverages', describeCodeCoverages_sortOrder - Specifies if the results are sorted in ascending or descending order.

DescribeCodeCoverages, describeCodeCoverages_reportArn - The ARN of the report for which test cases are returned.

Request Lenses

describeCodeCoverages_maxLineCoveragePercentage :: Lens' DescribeCodeCoverages (Maybe Double) Source #

The maximum line coverage percentage to report.

describeCodeCoverages_maxResults :: Lens' DescribeCodeCoverages (Maybe Natural) Source #

The maximum number of results to return.

describeCodeCoverages_minLineCoveragePercentage :: Lens' DescribeCodeCoverages (Maybe Double) Source #

The minimum line coverage percentage to report.

describeCodeCoverages_nextToken :: Lens' DescribeCodeCoverages (Maybe Text) Source #

The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

describeCodeCoverages_sortBy :: Lens' DescribeCodeCoverages (Maybe ReportCodeCoverageSortByType) Source #

Specifies how the results are sorted. Possible values are:

FILE_PATH: The results are sorted by file path.
LINE_COVERAGE_PERCENTAGE: The results are sorted by the percentage of lines that are covered.

describeCodeCoverages_sortOrder :: Lens' DescribeCodeCoverages (Maybe SortOrderType) Source #

Specifies if the results are sorted in ascending or descending order.

describeCodeCoverages_reportArn :: Lens' DescribeCodeCoverages Text Source #

The ARN of the report for which test cases are returned.

Destructuring the Response

data DescribeCodeCoveragesResponse Source #

See: newDescribeCodeCoveragesResponse smart constructor.

Constructors

DescribeCodeCoveragesResponse'
Fields codeCoverages :: Maybe [CodeCoverage] An array of `CodeCoverage` objects that contain the results. nextToken :: Maybe Text If there are more items to return, this contains a token that is passed to a subsequent call to `DescribeCodeCoverages` to retrieve the next set of items. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeCodeCoveragesResponse Source #

Arguments

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

Create a value of DescribeCodeCoveragesResponse 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:codeCoverages:DescribeCodeCoveragesResponse', describeCodeCoveragesResponse_codeCoverages - An array of CodeCoverage objects that contain the results.

DescribeCodeCoverages, describeCodeCoveragesResponse_nextToken - If there are more items to return, this contains a token that is passed to a subsequent call to DescribeCodeCoverages to retrieve the next set of items.

$sel:httpStatus:DescribeCodeCoveragesResponse', describeCodeCoveragesResponse_httpStatus - The response's http status code.

Response Lenses

describeCodeCoveragesResponse_codeCoverages :: Lens' DescribeCodeCoveragesResponse (Maybe [CodeCoverage]) Source #

An array of CodeCoverage objects that contain the results.

describeCodeCoveragesResponse_nextToken :: Lens' DescribeCodeCoveragesResponse (Maybe Text) Source #

If there are more items to return, this contains a token that is passed to a subsequent call to DescribeCodeCoverages to retrieve the next set of items.

describeCodeCoveragesResponse_httpStatus :: Lens' DescribeCodeCoveragesResponse Int Source #

The response's http status code.