Skip to content

list_reports_for_report_group

list_reports_for_report_group(
    report_group_arn: String,
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    next_token: Optional[String] = None,
    sort_order: Optional[SortOrderType] = None,
    max_results: Optional[PageSize] = None,
    filter: Optional[ReportFilter] = None,
) -> ListReportsForReportGroupOutput

Returns a list of ARNs for the reports that belong to a ReportGroup.

Parameters:

  • report_group_arn (String) –

    The ARN of the report group for which you want to return report ARNs.

  • next_token (Optional[String], default: None ) –

    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.

  • sort_order (Optional[SortOrderType], default: None ) –

    Use to specify whether the results are returned in ascending or descending order.

  • max_results (Optional[PageSize], default: None ) –

    The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

  • filter (Optional[ReportFilter], default: None ) –

    A ReportFilter object used to filter the returned reports.

Raises:

Source code in docs_src/capo_codebuild/_services/code_build.py
def list_reports_for_report_group(
    self,
    report_group_arn: "capo_codebuild.types.string.String",
    *,
    config_overrides: Optional[CodeBuildClientConfig] = None,
    next_token: Optional["capo_codebuild.types.string.String"] = None,
    sort_order: Optional[
        "capo_codebuild.types.sort_order_type.SortOrderType"
    ] = None,
    max_results: Optional["capo_codebuild.types.page_size.PageSize"] = None,
    filter: Optional["capo_codebuild.types.report_filter.ReportFilter"] = None,
) -> "capo_codebuild.types.list_reports_for_report_group_output.ListReportsForReportGroupOutput":
    """<p> Returns a list of ARNs for the reports that belong to a <code>ReportGroup</code>. </p>

    Args:
        report_group_arn: <p> The ARN of the report group for which you want to return report ARNs. </p>
        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>
        sort_order: <p> Use to specify whether the results are returned in ascending or descending order. </p>
        max_results: <p> The maximum number of paginated reports in this report group returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>Report</code> objects. The default value is 100. </p>
        filter: <p> A <code>ReportFilter</code> object used to filter the returned reports. </p>

    Raises:
        capo_codebuild.errors.invalid_input_exception.InvalidInputException: <p>The input value that was provided is not valid.</p>
        capo_codebuild.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified Amazon Web Services resource cannot be found.</p>
        capo_codebuild.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codebuild.types.list_reports_for_report_group_input.ListReportsForReportGroupInput]",
    ) -> OperationResponse[
        "capo_codebuild.types.list_reports_for_report_group_output.ListReportsForReportGroupOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.list_reports_for_report_group

        output, http_response = (
            capo_codebuild._operations.code_build_20161006.list_reports_for_report_group.list_reports_for_report_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListReportsForReportGroup")
    )
    input_: capo_codebuild.types.list_reports_for_report_group_input.ListReportsForReportGroupInput = {
        "report_group_arn": report_group_arn
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if max_results is not None:
        input_["max_results"] = max_results
    if filter is not None:
        input_["filter"] = filter

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output