CodeBuild / Client / list_shared_report_groups

list_shared_report_groups#

CodeBuild.Client.list_shared_report_groups(**kwargs)#

Gets a list of report groups that are shared with other Amazon Web Services accounts or users.

See also: AWS API Documentation

Request Syntax

response = client.list_shared_report_groups(
    sortOrder='ASCENDING'|'DESCENDING',
    sortBy='ARN'|'MODIFIED_TIME',
    nextToken='string',
    maxResults=123
)
Parameters:

  • sortOrder (string) –

    The order in which to list shared report groups. Valid values include:

    • ASCENDING: List in ascending order.

    • DESCENDING: List in descending order.

  • sortBy (string) –

    The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include:

    • ARN: List based on the ARN.

    • MODIFIED_TIME: List based on when information about the shared report group was last changed.

  • 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 shared report groups 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 shared with the current Amazon Web Services account or user.

      • (string) –

Exceptions

  • CodeBuild.Client.exceptions.InvalidInputException