describe_test_cases ¶

describe_test_cases(
    report_arn: String,
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    next_token: Optional[String] = None,
    max_results: Optional[PageSize] = None,
    filter: Optional[TestCaseFilter] = None,
) -> DescribeTestCasesOutput

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

Parameters:

report_arn (String) –

The ARN of the report for which test cases are returned.
next_token (Optional[String], default: None ) –

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.
max_results (Optional[PageSize], default: None ) –

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.
filter (Optional[TestCaseFilter], default: None ) –

A TestCaseFilter object used to filter the returned reports.

Raises:

InvalidInputException –

The input value that was provided is not valid.
ResourceNotFoundException –

The specified Amazon Web Services resource cannot be found.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_codebuild/_services/code_build.py

def describe_test_cases(
    self,
    report_arn: "capo_codebuild.types.string.String",
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    next_token: Optional["capo_codebuild.types.string.String"] = None,
    max_results: Optional["capo_codebuild.types.page_size.PageSize"] = None,
    filter: Optional["capo_codebuild.types.test_case_filter.TestCaseFilter"] = None,
) -> "capo_codebuild.types.describe_test_cases_output.DescribeTestCasesOutput":
    """<p> Returns a list of details about test cases for a report. </p>

    Args:
        report_arn: <p> The ARN of the report for which test cases are returned. </p>
        next_token: <p> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> 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. </p>
        max_results: <p> The maximum number of paginated test cases returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>TestCase</code> objects. The default value is 100. </p>
        filter: <p> A <code>TestCaseFilter</code> object used to filter the returned reports. </p>

    Raises:
        capo_codebuild.errors.invalid_input_exception.InvalidInputException: <p>The input value that was provided is not valid.</p>
        capo_codebuild.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified Amazon Web Services resource cannot be found.</p>
        capo_codebuild.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codebuild.types.describe_test_cases_input.DescribeTestCasesInput]",
    ) -> OperationResponse[
        "capo_codebuild.types.describe_test_cases_output.DescribeTestCasesOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.describe_test_cases

        output, http_response = (
            capo_codebuild._operations.code_build_20161006.describe_test_cases.describe_test_cases(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeTestCases")
    )
    input_: capo_codebuild.types.describe_test_cases_input.DescribeTestCasesInput = {
        "report_arn": report_arn
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filter is not None:
        input_["filter"] = filter

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output