Skip to content

update_report_group async

update_report_group(
    arn: NonEmptyString,
    *,
    config_overrides: Optional[AsyncCodeBuildClientConfig] = None,
    export_config: Optional[ReportExportConfig] = None,
    tags: Optional[TagList] = None,
) -> UpdateReportGroupOutput

Updates a report group.

Parameters:

  • arn (NonEmptyString) –

    The ARN of the report group to update.

  • export_config (Optional[ReportExportConfig], default: None ) –

    Used to specify an updated export type. Valid values are:

    • S3: The report results are exported to an S3 bucket.

    • NO_EXPORT: The report results are not exported.

  • tags (Optional[TagList], default: None ) –

    An updated list of tag key and value pairs associated with this report group.

    These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

Raises:

Source code in docs_src/capo_codebuild/_services/async_code_build.py
async def update_report_group(
    self,
    arn: "capo_codebuild.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[AsyncCodeBuildClientConfig] = None,
    export_config: Optional[
        "capo_codebuild.types.report_export_config.ReportExportConfig"
    ] = None,
    tags: Optional["capo_codebuild.types.tag_list.TagList"] = None,
) -> "capo_codebuild.types.update_report_group_output.UpdateReportGroupOutput":
    """<p> Updates a report group. </p>

    Args:
        arn: <p> The ARN of the report group to update. </p>
        export_config: <p> Used to specify an updated export type. Valid values are: </p> <ul> <li> <p> <code>S3</code>: The report results are exported to an S3 bucket. </p> </li> <li> <p> <code>NO_EXPORT</code>: The report results are not exported. </p> </li> </ul>
        tags: <p> An updated list of tag key and value pairs associated with this report group. </p> <p>These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codebuild.types.update_report_group_input.UpdateReportGroupInput]",
    ) -> AsyncOperationResponse[
        "capo_codebuild.types.update_report_group_output.UpdateReportGroupOutput"
    ]:
        import capo_codebuild._operations.code_build_20161006.update_report_group

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateReportGroup")
    )
    input_: capo_codebuild.types.update_report_group_input.UpdateReportGroupInput = {
        "arn": arn
    }
    if export_config is not None:
        input_["export_config"] = export_config
    if tags is not None:
        input_["tags"] = tags

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