XRay / Client / get_indexing_rules

get_indexing_rules#

XRay.Client.get_indexing_rules(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.get_indexing_rules(
    NextToken='string'
)
Parameters:

NextToken (string) – Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Return type:

dict

Returns:

Response Syntax

{
    'IndexingRules': [
        {
            'Name': 'string',
            'ModifiedAt': datetime(2015, 1, 1),
            'Rule': {
                'Probabilistic': {
                    'DesiredSamplingPercentage': 123.0,
                    'ActualSamplingPercentage': 123.0
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • IndexingRules (list) –

      Retrieves all indexing rules.

      • (dict) –

        Rule used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray.

        • Name (string) –

          The name of the indexing rule.

        • ModifiedAt (datetime) –

          Displays when the rule was last modified, in Unix time seconds.

        • Rule (dict) –

          The indexing rule.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: Probabilistic. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • Probabilistic (dict) –

            Indexing rule configuration that is used to probabilistically sample traceIds.

            • DesiredSamplingPercentage (float) –

              Configured sampling percentage of traceIds. Note that sampling can be subject to limits to ensure completeness of data.

            • ActualSamplingPercentage (float) –

              Applied sampling percentage of traceIds.

    • NextToken (string) –

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

Exceptions

  • XRay.Client.exceptions.InvalidRequestException

  • XRay.Client.exceptions.ThrottledException