ListSharedReportGroups

class CodeBuild.Paginator.ListSharedReportGroups

paginator = client.get_paginator('list_shared_report_groups')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    sortOrder='ASCENDING'|'DESCENDING',
    sortBy='ARN'|'MODIFIED_TIME',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

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

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

Response Structure

• (dict) --

  • reportGroups (list) --

    The list of ARNs for the report groups shared with the current Amazon Web Services account or user.

    • (string) --

  • NextToken (string) --

    A token to resume pagination.