CodeBuild / Client / list_report_groups

list_report_groups#

CodeBuild.Client.list_report_groups(**kwargs)#

Gets a list ARNs for the report groups in the current Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_report_groups(
    sortOrder='ASCENDING'|'DESCENDING',
    sortBy='NAME'|'CREATED_TIME'|'LAST_MODIFIED_TIME',
    nextToken='string',
    maxResults=123
)
Parameters:

  • sortOrder (string) – Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

  • sortBy (string) –

    The criterion to be used to list build report groups. Valid values include:

    • CREATED_TIME: List based on when each report group was created.

    • LAST_MODIFIED_TIME: List based on when each report group was last changed.

    • NAME: List based on each report group’s name.

  • 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 report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'reportGroups': [
        '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.

    • reportGroups (list) –

      The list of ARNs for the report groups in the current Amazon Web Services account.

      • (string) –

Exceptions

  • CodeBuild.Client.exceptions.InvalidInputException