CloudWatchObservabilityAdminService / Client / list_telemetry_rules

list_telemetry_rules

CloudWatchObservabilityAdminService.Client.list_telemetry_rules(**kwargs)

Lists all telemetry rules in your account. You can filter the results by specifying a rule name prefix.

See also: AWS API Documentation

Request Syntax

response = client.list_telemetry_rules(
    RuleNamePrefix='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • RuleNamePrefix (string) – A string to filter telemetry rules whose names begin with the specified prefix.

  • MaxResults (integer) – The maximum number of telemetry rules to return in a single call.

  • NextToken (string) – The token for the next set of results. A previous call generates this token.

Return type:

dict

Returns:

Response Syntax

{
    'TelemetryRuleSummaries': [
        {
            'RuleName': 'string',
            'RuleArn': 'string',
            'CreatedTimeStamp': 123,
            'LastUpdateTimeStamp': 123,
            'ResourceType': 'AWS::EC2::Instance'|'AWS::EC2::VPC'|'AWS::Lambda::Function'|'AWS::CloudTrail'|'AWS::EKS::Cluster'|'AWS::WAFv2::WebACL'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::Route53Resolver::ResolverEndpoint'|'AWS::BedrockAgentCore::Runtime'|'AWS::BedrockAgentCore::Browser'|'AWS::BedrockAgentCore::CodeInterpreter',
            'TelemetryType': 'Logs'|'Metrics'|'Traces',
            'TelemetrySourceTypes': [
                'VPC_FLOW_LOGS'|'ROUTE53_RESOLVER_QUERY_LOGS'|'EKS_AUDIT_LOGS'|'EKS_AUTHENTICATOR_LOGS'|'EKS_CONTROLLER_MANAGER_LOGS'|'EKS_SCHEDULER_LOGS'|'EKS_API_LOGS',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • TelemetryRuleSummaries (list) –

      A list of telemetry rule summaries.

      • (dict) –

        A summary of a telemetry rule’s key properties.

        • RuleName (string) –

          The name of the telemetry rule.

        • RuleArn (string) –

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

        • CreatedTimeStamp (integer) –

          The timestamp when the telemetry rule was created.

        • LastUpdateTimeStamp (integer) –

          The timestamp when the telemetry rule was last modified.

        • ResourceType (string) –

          The type of Amazon Web Services resource the rule applies to.

        • TelemetryType (string) –

          The type of telemetry (Logs, Metrics, or Traces) the rule configures.

        • TelemetrySourceTypes (list) –

          The types of telemetry sources configured for this rule, such as VPC Flow Logs or EKS audit logs. TelemetrySourceTypes must be correlated with the specific resource type.

          • (string) –

            Specifies the type of telemetry source for a resource, such as EKS cluster logs.

    • NextToken (string) –

      A token to resume pagination of results.

Exceptions