CodeBuild / Client / list_reports

list_reports#

CodeBuild.Client.list_reports(**kwargs)#

Returns a list of ARNs for the reports in the current Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_reports(
    sortOrder='ASCENDING'|'DESCENDING',
    nextToken='string',
    maxResults=123,
    filter={
        'status': 'GENERATING'|'SUCCEEDED'|'FAILED'|'INCOMPLETE'|'DELETING'
    }
)
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.

  • nextToken (string) – 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.

  • maxResults (integer) – The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • nextToken (string) –

      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.

    • reports (list) –

      The list of returned ARNs for the reports in the current Amazon Web Services account.

      • (string) –

Exceptions

  • CodeBuild.Client.exceptions.InvalidInputException