Skip to content

get_indexing_rules 

get_indexing_rules(
    *,
    config_overrides: Optional[XRayClientConfig] = None,
    next_token: Optional[String] = None,
) -> GetIndexingRulesResult

Retrieves all indexing rules.

Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.

Parameters:

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

    Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Raises:

Source code in docs_src/capo_xray/_services/x_ray.py 
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
def get_indexing_rules(
    self,
    *,
    config_overrides: Optional[XRayClientConfig] = None,
    next_token: Optional["capo_xray.types.string.String"] = None,
) -> "capo_xray.types.get_indexing_rules_result.GetIndexingRulesResult":
    """<p> Retrieves all indexing rules.</p> <p>Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Transaction-Search.html">Transaction Search</a>.</p>

    Args:
        next_token: <p> Specify the pagination token returned by a previous request to retrieve the next page of indexes. </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_indexing_rules_request.GetIndexingRulesRequest]",
    ) -> OperationResponse[
        "capo_xray.types.get_indexing_rules_result.GetIndexingRulesResult"
    ]:
        import capo_xray._operations.awsx_ray.get_indexing_rules

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIndexingRules")
    )
    input_: capo_xray.types.get_indexing_rules_request.GetIndexingRulesRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token

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