Skip to main content

telemetry_rules_for_organizations

Creates, updates, deletes, gets or lists a telemetry_rules_for_organizations resource.

Overview

Nametelemetry_rules_for_organizations
TypeResource
Idaws.observabilityadmin.telemetry_rules_for_organizations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
created_time_stampinteger (int64)The timestamp when the telemetry rule was created.
last_update_time_stampinteger (int64)The timestamp when the telemetry rule was last modified.
resource_typestringThe type of Amazon Web Services resource the rule applies to. (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, AWS::BedrockAgentCore::Gateway, AWS::BedrockAgentCore::Memory, AWS::BedrockAgentCore::WorkloadIdentity, AWS::SecurityHub::Hub, AWS::CloudFront::Distribution, AWS::SecurityHub::HubV2, AWS::CloudWatch::OTelEnrichment, AWS::MSK::Cluster, AWS::S3::Bucket, AWS::Bedrock::KnowledgeBase)
rule_arnstringThe Amazon Resource Name (ARN) of the telemetry rule. (pattern: <code>arn:aws([a-z0-9-]+)?:([a-zA-Z0-9-]+):([a-z0-9-]+)?:([0-9]{12})?:(.+)</code>)
rule_namestringThe name of the telemetry rule. (pattern: <code>[0-9A-Za-z-_.#/]+</code>)
telemetry_source_typesarrayThe 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.
telemetry_typestringThe type of telemetry (Logs, Metrics, or Traces) the rule configures. (Logs, Metrics, Traces)

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_telemetry_rules_for_organizationselectregionLists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples

Lists all telemetry rules in your organization. This operation can only be called by the organization's management account or a delegated administrator account.

SELECT
created_time_stamp,
last_update_time_stamp,
resource_type,
rule_arn,
rule_name,
telemetry_source_types,
telemetry_type
FROM aws.observabilityadmin.telemetry_rules_for_organizations
WHERE region = '{{ region }}' -- required
;