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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of details about test cases for a report.

This operation returns paginated results.

Synopsis

data DescribeTestCases = DescribeTestCases' {
- filter' :: Maybe TestCaseFilter
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- reportArn :: Text
}
newDescribeTestCases :: Text -> DescribeTestCases
describeTestCases_filter :: Lens' DescribeTestCases (Maybe TestCaseFilter)
describeTestCases_maxResults :: Lens' DescribeTestCases (Maybe Natural)
describeTestCases_nextToken :: Lens' DescribeTestCases (Maybe Text)
describeTestCases_reportArn :: Lens' DescribeTestCases Text
data DescribeTestCasesResponse = DescribeTestCasesResponse' {
- nextToken :: Maybe Text
- testCases :: Maybe [TestCase]
- httpStatus :: Int
}
newDescribeTestCasesResponse :: Int -> DescribeTestCasesResponse
describeTestCasesResponse_nextToken :: Lens' DescribeTestCasesResponse (Maybe Text)
describeTestCasesResponse_testCases :: Lens' DescribeTestCasesResponse (Maybe [TestCase])
describeTestCasesResponse_httpStatus :: Lens' DescribeTestCasesResponse Int

Creating a Request

data DescribeTestCases Source #

See: newDescribeTestCases smart constructor.

Constructors

DescribeTestCases'

Fields

filter' :: Maybe TestCaseFilter
A TestCaseFilter object used to filter the returned reports.
maxResults :: Maybe Natural
The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase 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.
reportArn :: Text
The ARN of the report for which test cases are returned.

Instances

Instances details

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

newDescribeTestCases Source #

Arguments

:: Text	`DescribeTestCases`
-> DescribeTestCases

Create a value of DescribeTestCases 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:filter':DescribeTestCases', describeTestCases_filter - A TestCaseFilter object used to filter the returned reports.

$sel:maxResults:DescribeTestCases', describeTestCases_maxResults - The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is 100.

DescribeTestCases, describeTestCases_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.

DescribeTestCases, describeTestCases_reportArn - The ARN of the report for which test cases are returned.

Request Lenses

describeTestCases_filter :: Lens' DescribeTestCases (Maybe TestCaseFilter) Source #

A TestCaseFilter object used to filter the returned reports.

describeTestCases_maxResults :: Lens' DescribeTestCases (Maybe Natural) Source #

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

describeTestCases_nextToken :: Lens' DescribeTestCases (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.

describeTestCases_reportArn :: Lens' DescribeTestCases Text Source #

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

Destructuring the Response

data DescribeTestCasesResponse Source #

See: newDescribeTestCasesResponse smart constructor.

Constructors

DescribeTestCasesResponse'

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.
testCases :: Maybe [TestCase]
The returned list of test cases.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeTestCasesResponse Source #

Arguments

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

Create a value of DescribeTestCasesResponse 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:

DescribeTestCases, describeTestCasesResponse_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:testCases:DescribeTestCasesResponse', describeTestCasesResponse_testCases - The returned list of test cases.

$sel:httpStatus:DescribeTestCasesResponse', describeTestCasesResponse_httpStatus - The response's http status code.

Response Lenses

describeTestCasesResponse_nextToken :: Lens' DescribeTestCasesResponse (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.

describeTestCasesResponse_testCases :: Lens' DescribeTestCasesResponse (Maybe [TestCase]) Source #

The returned list of test cases.

describeTestCasesResponse_httpStatus :: Lens' DescribeTestCasesResponse Int Source #

The response's http status code.