XRay / Client / update_indexing_rule

update_indexing_rule#

XRay.Client.update_indexing_rule(**kwargs)#

Modifies an indexing rule’s configuration.

Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

See also: AWS API Documentation

Request Syntax

response = client.update_indexing_rule(
    Name='string',
    Rule={
        'Probabilistic': {
            'DesiredSamplingPercentage': 123.0
        }
    }
)
Parameters:

  • Name (string) –

    [REQUIRED]

    Name of the indexing rule to be updated.

  • Rule (dict) –

    [REQUIRED]

    Rule configuration to be updated.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: Probabilistic.

    • Probabilistic (dict) –

      Indexing rule configuration that is used to probabilistically sample traceIds.

      • DesiredSamplingPercentage (float) – [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'IndexingRule': {
        'Name': 'string',
        'ModifiedAt': datetime(2015, 1, 1),
        'Rule': {
            'Probabilistic': {
                'DesiredSamplingPercentage': 123.0,
                'ActualSamplingPercentage': 123.0
            }
        }
    }
}

Response Structure

  • (dict) –

    • IndexingRule (dict) –

      Updated indexing rule.

      • 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.

Exceptions