ListReports

class CodeBuild.Paginator.ListReports
paginator = client.get_paginator('list_reports')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

    Specifies the sort order for the list of returned reports. Valid values are:

    • ASCENDING : return reports in chronological order based on their creation date.
    • DESCENDING : return reports in the reverse chronological order based on their creation date.
  • 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 returned ARNs for the reports in the current Amazon Web Services account.

      • (string) --
    • NextToken (string) --

      A token to resume pagination.