CodeBuild / Paginator / DescribeTestCases

DescribeTestCases

class CodeBuild.Paginator.DescribeTestCases

paginator = client.get_paginator('describe_test_cases')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeBuild.Client.describe_test_cases().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    reportArn='string',
    filter={
        'status': 'string',
        'keyword': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• reportArn (string) –

  [REQUIRED]

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

• filter (dict) –

  A TestCaseFilter object used to filter the returned reports.

  • status (string) –

    The status used to filter test cases. A TestCaseFilter can have one status. Valid values are:

    • SUCCEEDED

    • FAILED

    • ERROR

    • SKIPPED

    • UNKNOWN

  • keyword (string) –

    A keyword that is used to filter on the name or the prefix of the test cases. Only test cases where the keyword is a substring of the name or the prefix will be returned.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'testCases': [
        {
            'reportArn': 'string',
            'testRawDataPath': 'string',
            'prefix': 'string',
            'name': 'string',
            'status': 'string',
            'durationInNanoSeconds': 123,
            'message': 'string',
            'expired': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • testCases (list) –

    The returned list of test cases.

    • (dict) –

      Information about a test case created using a framework such as NUnit or Cucumber. A test case might be a unit test or a configuration test.

      • reportArn (string) –

        The ARN of the report to which the test case belongs.

      • testRawDataPath (string) –

        The path to the raw data file that contains the test result.

      • prefix (string) –

        A string that is applied to a series of related test cases. CodeBuild generates the prefix. The prefix depends on the framework used to generate the tests.

      • name (string) –

        The name of the test case.

      • status (string) –

        The status returned by the test case after it was run. Valid statuses are SUCCEEDED, FAILED, ERROR, SKIPPED, and UNKNOWN.

      • durationInNanoSeconds (integer) –

        The number of nanoseconds it took to run this test case.

      • message (string) –

        A message associated with a test case. For example, an error message or stack trace.

      • expired (datetime) –

        The date and time a test case expires. A test case expires 30 days after it is created. An expired test case is not available to view in CodeBuild.

  • NextToken (string) –

    A token to resume pagination.