get_sampling_targets ¶

def get_sampling_targets(
    self,
    sampling_statistics_documents: "capo_xray.types.sampling_statistics_document_list.SamplingStatisticsDocumentList",
    *,
    config_overrides: Optional[XRayClientConfig] = None,
    sampling_boost_statistics_documents: Optional[
        "capo_xray.types.sampling_boost_statistics_document_list.SamplingBoostStatisticsDocumentList"
    ] = None,
) -> "capo_xray.types.get_sampling_targets_result.GetSamplingTargetsResult":
    """<p>Requests a sampling quota for rules that the service is using to sample requests. </p>

    Args:
        sampling_statistics_documents: <p>Information about rules that the service is using to sample requests.</p>
        sampling_boost_statistics_documents: <p>Information about rules that the service is using to boost sampling rate.</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.
    """

    def _handler(
        req: "OperationRequest[capo_xray.types.get_sampling_targets_request.GetSamplingTargetsRequest]",
    ) -> OperationResponse[
        "capo_xray.types.get_sampling_targets_result.GetSamplingTargetsResult"
    ]:
        import capo_xray._operations.awsx_ray.get_sampling_targets

        output, http_response = (
            capo_xray._operations.awsx_ray.get_sampling_targets.get_sampling_targets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSamplingTargets")
    )
    input_: capo_xray.types.get_sampling_targets_request.GetSamplingTargetsRequest = {
        "sampling_statistics_documents": sampling_statistics_documents
    }
    if sampling_boost_statistics_documents is not None:
        input_["sampling_boost_statistics_documents"] = (
            sampling_boost_statistics_documents
        )

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