list_shared_report_groups async ¶

async def list_shared_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.shared_resource_sort_by_type.SharedResourceSortByType"
    ] = None,
    next_token: Optional["capo_codebuild.types.string.String"] = None,
    max_results: Optional["capo_codebuild.types.page_size.PageSize"] = None,
) -> "capo_codebuild.types.list_shared_report_groups_output.ListSharedReportGroupsOutput":
    """<p> Gets a list of report groups that are shared with other Amazon Web Services accounts or users. </p>

    Args:
        sort_order: <p>The order in which to list shared report groups. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List in ascending order.</p> </li> <li> <p> <code>DESCENDING</code>: List in descending order.</p> </li> </ul>
        sort_by: <p> The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include: </p> <ul> <li> <p> <code>ARN</code>: List based on the ARN. </p> </li> <li> <p> <code>MODIFIED_TIME</code>: List based on when information about the shared report group was last changed. </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 shared report groups 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_shared_report_groups_input.ListSharedReportGroupsInput]",
    ) -> AsyncOperationResponse[
        "capo_codebuild.types.list_shared_report_groups_output.ListSharedReportGroupsOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.list_shared_report_groups

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSharedReportGroups")
    )
    input_: capo_codebuild.types.list_shared_report_groups_input.ListSharedReportGroupsInput = {}
    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