Skip to content

update_sampling_rule async

update_sampling_rule(
    sampling_rule_update: SamplingRuleUpdate,
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
) -> UpdateSamplingRuleResult

Modifies a sampling rule's configuration.

Parameters:

Raises:

Source code in docs_src/capo_xray/_services/async_x_ray.py
async def update_sampling_rule(
    self,
    sampling_rule_update: "capo_xray.types.sampling_rule_update.SamplingRuleUpdate",
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
) -> "capo_xray.types.update_sampling_rule_result.UpdateSamplingRuleResult":
    """<p>Modifies a sampling rule's configuration.</p>

    Args:
        sampling_rule_update: <p>The rule and fields to change.</p>

    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_sampling_rule_request.UpdateSamplingRuleRequest]",
    ) -> AsyncOperationResponse[
        "capo_xray.types.update_sampling_rule_result.UpdateSamplingRuleResult"
    ]:
        import capo_xray._operations.awsx_ray.update_sampling_rule

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSamplingRule")
    )
    input_: capo_xray.types.update_sampling_rule_request.UpdateSamplingRuleRequest = {
        "sampling_rule_update": sampling_rule_update
    }

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