list_report_groups async ¶

async def list_report_groups(
    self,
    *,
    config_overrides: Optional[AsyncCodeBuildClientConfig] = None,
    sort_order: Optional[
        "capo_codebuild.types.sort_order_type.SortOrderType"
    ] = None,
    sort_by: Optional[
        "capo_codebuild.types.report_group_sort_by_type.ReportGroupSortByType"
    ] = None,
    next_token: Optional["capo_codebuild.types.string.String"] = None,
    max_results: Optional["capo_codebuild.types.page_size.PageSize"] = None,
) -> "capo_codebuild.types.list_report_groups_output.ListReportGroupsOutput":
    """<p> Gets a list ARNs for the report groups in the current Amazon Web Services account. </p>

    Args:
        sort_order: <p> Used to specify the order to sort the list of returned report groups. Valid values are <code>ASCENDING</code> and <code>DESCENDING</code>. </p>
        sort_by: <p> The criterion to be used to list build report groups. Valid values include: </p> <ul> <li> <p> <code>CREATED_TIME</code>: List based on when each report group was created.</p> </li> <li> <p> <code>LAST_MODIFIED_TIME</code>: List based on when each report group was last changed.</p> </li> <li> <p> <code>NAME</code>: List based on each report group's name.</p> </li> </ul>
        next_token: <p> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> 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. </p>
        max_results: <p> The maximum number of paginated report groups returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>ReportGroup</code> objects. The default value is 100. </p>

    Raises:
        capo_codebuild.errors.invalid_input_exception.InvalidInputException: <p>The input value that was provided is not valid.</p>
        capo_codebuild.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codebuild.types.list_report_groups_input.ListReportGroupsInput]",
    ) -> AsyncOperationResponse[
        "capo_codebuild.types.list_report_groups_output.ListReportGroupsOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.list_report_groups

        (
            output,
            http_response,
        ) = await capo_codebuild._operations.code_build_20161006.list_report_groups.async_list_report_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReportGroups")
    )
    input_: capo_codebuild.types.list_report_groups_input.ListReportGroupsInput = {}
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output