update_group async ¶

async def update_group(
    self,
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
    group_name: Optional["capo_xray.types.group_name.GroupName"] = None,
    group_arn: Optional["capo_xray.types.group_arn.GroupARN"] = None,
    filter_expression: Optional[
        "capo_xray.types.filter_expression.FilterExpression"
    ] = None,
    insights_configuration: Optional[
        "capo_xray.types.insights_configuration.InsightsConfiguration"
    ] = None,
) -> "capo_xray.types.update_group_result.UpdateGroupResult":
    """<p>Updates a group resource.</p>

    Args:
        group_name: <p>The case-sensitive name of the group.</p>
        group_arn: <p>The ARN that was generated upon creation.</p>
        filter_expression: <p>The updated filter expression defining criteria by which to group traces.</p>
        insights_configuration: <p>The structure containing configurations related to insights.</p> <ul> <li> <p>The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.</p> </li> <li> <p>The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.</p> </li> </ul>

    Raises:
        capo_xray.errors.invalid_request_exception.InvalidRequestException: <p>The request is missing required parameters or has invalid parameters.</p>
        capo_xray.errors.throttled_exception.ThrottledException: <p>The request exceeds the maximum number of requests per second.</p>
        capo_xray.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_xray.types.update_group_request.UpdateGroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_xray.types.update_group_result.UpdateGroupResult"
    ]:
        import capo_xray._operations.awsx_ray.update_group

        (
            output,
            http_response,
        ) = await capo_xray._operations.awsx_ray.update_group.async_update_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateGroup")
    )
    input_: capo_xray.types.update_group_request.UpdateGroupRequest = {}
    if group_name is not None:
        input_["group_name"] = group_name
    if group_arn is not None:
        input_["group_arn"] = group_arn
    if filter_expression is not None:
        input_["filter_expression"] = filter_expression
    if insights_configuration is not None:
        input_["insights_configuration"] = insights_configuration

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