CloudWatchObservabilityAdminService / Client / update_telemetry_rule

update_telemetry_rule

CloudWatchObservabilityAdminService.Client.update_telemetry_rule(**kwargs)

Updates an existing telemetry rule in your account.

See also: AWS API Documentation

Request Syntax

response = client.update_telemetry_rule(
    RuleIdentifier='string',
    Rule={
        'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function',
        'TelemetryType': 'Logs'|'Metrics'|'Traces',
        'DestinationConfiguration': {
            'DestinationType': 'cloud-watch-logs',
            'DestinationPattern': 'string',
            'RetentionInDays': 123,
            'VPCFlowLogParameters': {
                'LogFormat': 'string',
                'TrafficType': 'string',
                'MaxAggregationInterval': 123
            }
        },
        'Scope': 'string',
        'SelectionCriteria': 'string'
    }
)
Parameters:

  • RuleIdentifier (string) –

    [REQUIRED]

    The identifier (name or ARN) of the telemetry rule to update.

  • Rule (dict) –

    [REQUIRED]

    The new configuration details for the telemetry rule.

    • ResourceType (string) –

      The type of Amazon Web Services resource to configure telemetry for (e.g., “AWS::EC2::VPC”).

    • TelemetryType (string) – [REQUIRED]

      The type of telemetry to collect (Logs, Metrics, or Traces).

    • DestinationConfiguration (dict) –

      Configuration specifying where and how the telemetry data should be delivered.

      • DestinationType (string) –

        The type of destination for the telemetry data (e.g., “Amazon CloudWatch Logs”, “S3”).

      • DestinationPattern (string) –

        The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.

      • RetentionInDays (integer) –

        The number of days to retain the telemetry data in the destination.

      • VPCFlowLogParameters (dict) –

        Configuration parameters specific to VPC Flow Logs when VPC is the resource type.

        • LogFormat (string) –

          The format in which VPC Flow Log entries should be logged.

        • TrafficType (string) –

          The type of traffic to log (ACCEPT, REJECT, or ALL).

        • MaxAggregationInterval (integer) –

          The maximum interval in seconds between the capture of flow log records.

    • Scope (string) –

      The organizational scope to which the rule applies, specified using accounts or organizational units.

    • SelectionCriteria (string) –

      Criteria for selecting which resources the rule applies to, such as resource tags.

Return type:

dict

Returns:

Response Syntax

{
    'RuleArn': 'string'
}

Response Structure

  • (dict) –

    • RuleArn (string) –

      The Amazon Resource Name (ARN) of the updated telemetry rule.

Exceptions