CodeBuild / Paginator / ListReportsForReportGroup

ListReportsForReportGroup

class CodeBuild.Paginator.ListReportsForReportGroup

paginator = client.get_paginator('list_reports_for_report_group')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    reportGroupArn='string',
    sortOrder='ASCENDING'|'DESCENDING',
    filter={
        'status': 'GENERATING'|'SUCCEEDED'|'FAILED'|'INCOMPLETE'|'DELETING'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• reportGroupArn (string) –

  [REQUIRED]

  The ARN of the report group for which you want to return report ARNs.

• sortOrder (string) – Use to specify whether the results are returned in ascending or descending order.

• filter (dict) –

  A ReportFilter object used to filter the returned reports.

  • status (string) –

    The status used to filter reports. You can filter using one status only.

• 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

{
    'reports': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • reports (list) –

    The list of report ARNs.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.