Class: Aws::ObservabilityAdmin::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb

Overview

An API client for ObservabilityAdmin. To construct a client, you need to configure a :region and :credentials.

client = Aws::ObservabilityAdmin::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. Takes effect only when disable_clock_skew_correction is not set.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ObservabilityAdmin::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ObservabilityAdmin::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



478
479
480
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 478

def initialize(*args)
  super
end

Instance Method Details

#create_centralization_rule_for_organization(params = {}) ⇒ Types::CreateCentralizationRuleForOrganizationOutput

Creates a centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Examples:

Request syntax with placeholder values


resp = client.create_centralization_rule_for_organization({
  rule_name: "RuleName", # required
  rule: { # required
    source: { # required
      regions: ["Region"], # required
      scope: "SourceFilterString",
      source_logs_configuration: {
        log_group_selection_criteria: "LogsFilterString",
        data_source_selection_criteria: "DataSourceFilterString",
        encrypted_log_group_strategy: "ALLOW", # required, accepts ALLOW, SKIP
      },
      source_metrics_configuration: {
        metrics_selection_criteria: "MetricsFilterString",
      },
      source_context_graph_configuration: {
      },
    },
    destination: { # required
      region: "Region", # required
      account: "AccountIdentifier",
      destination_logs_configuration: {
        logs_encryption_configuration: {
          encryption_strategy: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, AWS_OWNED
          kms_key_arn: "ResourceArn",
          encryption_conflict_resolution_strategy: "ALLOW", # accepts ALLOW, SKIP
          encryption_scope: "ENCRYPTED_SOURCE_ONLY", # accepts ENCRYPTED_SOURCE_ONLY, NEW_DESTINATION_LOG_GROUPS
        },
        backup_configuration: {
          region: "Region", # required
          kms_key_arn: "ResourceArn",
        },
        log_group_name_configuration: {
          log_group_name_pattern: "LogGroupNamePattern", # required
        },
        tag_propagation_configuration: {
          destination_role_arn: "IamRoleArn", # required
          tag_conflict_resolution_strategy: "IN_SYNC", # accepts IN_SYNC, ADD_ONLY, UPDATE_SYNC
        },
        log_group_deletion_protection: "ENABLED", # accepts ENABLED
      },
      destination_metrics_configuration: {
        backup_configuration: {
          region: "Region", # required
        },
      },
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_name (required, String) —

    A unique name for the organization-wide centralization rule being created.

  • :rule (required, Types::CentralizationRule) —

    The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.

  • :tags (Hash<String,String>) —

    The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.

Returns:

See Also:



568
569
570
571
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 568

def create_centralization_rule_for_organization(params = {}, options = {})
  req = build_request(:create_centralization_rule_for_organization, params)
  req.send_request(options)
end

#create_dataset_integration(params = {}) ⇒ Types::CreateDatasetIntegrationOutput

Creates a dataset integration for the caller's account in the current region and returns its ARN.

To use this operation, you must have permission to access the dataset integration resources through the IAM role specified in the RoleArn parameter.

If a dataset integration already exists for the account, this operation fails with a ConflictException.

Examples:

Request syntax with placeholder values


resp = client.create_dataset_integration({
  role_arn: "ResourceArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String
resp.role_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that grants Amazon CloudWatch permission to access the resources needed for the dataset integration.

  • :tags (Hash<String,String>) —

    The key-value pairs to associate with the dataset integration resource for categorization and management purposes.

Returns:

See Also:



619
620
621
622
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 619

def create_dataset_integration(params = {}, options = {})
  req = build_request(:create_dataset_integration, params)
  req.send_request(options)
end

#create_s3_table_integration(params = {}) ⇒ Types::CreateS3TableIntegrationOutput

Creates an integration between CloudWatch and S3 Tables for analytics. This integration enables querying CloudWatch telemetry data using analytics engines like Amazon Athena, Amazon Redshift, and Apache Spark.

Examples:

Request syntax with placeholder values


resp = client.create_s3_table_integration({
  encryption: { # required
    sse_algorithm: "aws:kms", # required, accepts aws:kms, AES256
    kms_key_arn: "ResourceArn",
  },
  role_arn: "ResourceArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :encryption (required, Types::Encryption) —

    The encryption configuration for the S3 Table integration, including the encryption algorithm and KMS key settings.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role that grants permissions for the S3 Table integration to access necessary resources.

  • :tags (Hash<String,String>) —

    The key-value pairs to associate with the S3 Table integration resource for categorization and management purposes.

Returns:

See Also:



666
667
668
669
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 666

def create_s3_table_integration(params = {}, options = {})
  req = build_request(:create_s3_table_integration, params)
  req.send_request(options)
end

#create_telemetry_pipeline(params = {}) ⇒ Types::CreateTelemetryPipelineOutput

Creates a telemetry pipeline for processing and transforming telemetry data. The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.

Examples:

Request syntax with placeholder values


resp = client.create_telemetry_pipeline({
  name: "TelemetryPipelineName", # required
  configuration: { # required
    body: "TelemetryPipelineConfigurationBody", # required
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the telemetry pipeline to create. The name must be unique within your account.

  • :configuration (required, Types::TelemetryPipelineConfiguration) —

    The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations. For more information about pipeline components, see the Amazon CloudWatch User Guide

  • :tags (Hash<String,String>) —

    The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.

Returns:

See Also:



718
719
720
721
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 718

def create_telemetry_pipeline(params = {}, options = {})
  req = build_request(:create_telemetry_pipeline, params)
  req.send_request(options)
end

#create_telemetry_rule(params = {}) ⇒ Types::CreateTelemetryRuleOutput

Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

Examples:

Request syntax with placeholder values


resp = client.create_telemetry_rule({
  rule_name: "RuleName", # required
  rule: { # required
    resource_type: "AWS::EC2::Instance", # accepts 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::BedrockAgentCore::PaymentManager, AWS::SecurityHub::Hub, AWS::CloudFront::Distribution, AWS::SecurityHub::HubV2, AWS::CloudWatch::OTelEnrichment, AWS::MSK::Cluster, AWS::S3::Bucket, AWS::Bedrock::KnowledgeBase, AWS::XRay::TransactionSearchConfig
    telemetry_type: "Logs", # required, accepts Logs, Metrics, Traces, Insights
    telemetry_source_types: ["VPC_FLOW_LOGS"], # accepts VPC_FLOW_LOGS, ROUTE53_RESOLVER_QUERY_LOGS, EKS_AUDIT_LOGS, EKS_AUTHENTICATOR_LOGS, EKS_CONTROLLER_MANAGER_LOGS, EKS_SCHEDULER_LOGS, EKS_API_LOGS
    destination_configuration: {
      destination_type: "cloud-watch-logs", # accepts cloud-watch-logs
      destination_pattern: "String",
      retention_in_days: 1,
      vpc_flow_log_parameters: {
        log_format: "String",
        traffic_type: "String",
        max_aggregation_interval: 1,
      },
      cloudtrail_parameters: {
        advanced_event_selectors: [ # required
          {
            name: "String",
            field_selectors: [ # required
              {
                field: "String", # required
                equals: ["String"],
                starts_with: ["String"],
                ends_with: ["String"],
                not_equals: ["String"],
                not_starts_with: ["String"],
                not_ends_with: ["String"],
              },
            ],
          },
        ],
      },
      elb_load_balancer_logging_parameters: {
        output_format: "plain", # accepts plain, json
        field_delimiter: "String",
      },
      waf_logging_parameters: {
        redacted_fields: [
          {
            single_header: {
              name: "SingleHeaderNameString",
            },
            uri_path: "String",
            query_string: "String",
            method: "String",
          },
        ],
        logging_filter: {
          filters: [
            {
              behavior: "KEEP", # accepts KEEP, DROP
              requirement: "MEETS_ALL", # accepts MEETS_ALL, MEETS_ANY
              conditions: [
                {
                  action_condition: {
                    action: "ALLOW", # accepts ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE, EXCLUDED_AS_COUNT
                  },
                  label_name_condition: {
                    label_name: "LabelNameConditionLabelNameString",
                  },
                },
              ],
            },
          ],
          default_behavior: "KEEP", # accepts KEEP, DROP
        },
        log_type: "WAF_LOGS", # accepts WAF_LOGS
      },
      log_delivery_parameters: {
        log_types: ["APPLICATION_LOGS"], # accepts APPLICATION_LOGS, USAGE_LOGS, SECURITY_FINDING_LOGS, ACCESS_LOGS, CONNECTION_LOGS, S3_SERVER_ACCESS_LOGS, ALB_ACCESS_LOGS, ALB_CONNECTION_LOGS, ALB_HEALTH_CHECK_LOGS
      },
      msk_monitoring_parameters: {
        enhanced_monitoring: "DEFAULT", # accepts DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, PER_TOPIC_PER_PARTITION
      },
      kms_key_arn: "KmsKeyArn",
    },
    scope: "String",
    selection_criteria: "String",
    allow_field_updates: false,
    regions: ["Region"],
    all_regions: false,
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_name (required, String) —

    A unique name for the telemetry rule being created.

  • :rule (required, Types::TelemetryRule) —

    The configuration details for the telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to.

  • :tags (Hash<String,String>) —

    The key-value pairs to associate with the telemetry rule resource for categorization and management purposes.

Returns:

See Also:



843
844
845
846
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 843

def create_telemetry_rule(params = {}, options = {})
  req = build_request(:create_telemetry_rule, params)
  req.send_request(options)
end

#create_telemetry_rule_for_organization(params = {}) ⇒ Types::CreateTelemetryRuleForOrganizationOutput

Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Examples:

Request syntax with placeholder values


resp = client.create_telemetry_rule_for_organization({
  rule_name: "RuleName", # required
  rule: { # required
    resource_type: "AWS::EC2::Instance", # accepts 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::BedrockAgentCore::PaymentManager, AWS::SecurityHub::Hub, AWS::CloudFront::Distribution, AWS::SecurityHub::HubV2, AWS::CloudWatch::OTelEnrichment, AWS::MSK::Cluster, AWS::S3::Bucket, AWS::Bedrock::KnowledgeBase, AWS::XRay::TransactionSearchConfig
    telemetry_type: "Logs", # required, accepts Logs, Metrics, Traces, Insights
    telemetry_source_types: ["VPC_FLOW_LOGS"], # accepts VPC_FLOW_LOGS, ROUTE53_RESOLVER_QUERY_LOGS, EKS_AUDIT_LOGS, EKS_AUTHENTICATOR_LOGS, EKS_CONTROLLER_MANAGER_LOGS, EKS_SCHEDULER_LOGS, EKS_API_LOGS
    destination_configuration: {
      destination_type: "cloud-watch-logs", # accepts cloud-watch-logs
      destination_pattern: "String",
      retention_in_days: 1,
      vpc_flow_log_parameters: {
        log_format: "String",
        traffic_type: "String",
        max_aggregation_interval: 1,
      },
      cloudtrail_parameters: {
        advanced_event_selectors: [ # required
          {
            name: "String",
            field_selectors: [ # required
              {
                field: "String", # required
                equals: ["String"],
                starts_with: ["String"],
                ends_with: ["String"],
                not_equals: ["String"],
                not_starts_with: ["String"],
                not_ends_with: ["String"],
              },
            ],
          },
        ],
      },
      elb_load_balancer_logging_parameters: {
        output_format: "plain", # accepts plain, json
        field_delimiter: "String",
      },
      waf_logging_parameters: {
        redacted_fields: [
          {
            single_header: {
              name: "SingleHeaderNameString",
            },
            uri_path: "String",
            query_string: "String",
            method: "String",
          },
        ],
        logging_filter: {
          filters: [
            {
              behavior: "KEEP", # accepts KEEP, DROP
              requirement: "MEETS_ALL", # accepts MEETS_ALL, MEETS_ANY
              conditions: [
                {
                  action_condition: {
                    action: "ALLOW", # accepts ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE, EXCLUDED_AS_COUNT
                  },
                  label_name_condition: {
                    label_name: "LabelNameConditionLabelNameString",
                  },
                },
              ],
            },
          ],
          default_behavior: "KEEP", # accepts KEEP, DROP
        },
        log_type: "WAF_LOGS", # accepts WAF_LOGS
      },
      log_delivery_parameters: {
        log_types: ["APPLICATION_LOGS"], # accepts APPLICATION_LOGS, USAGE_LOGS, SECURITY_FINDING_LOGS, ACCESS_LOGS, CONNECTION_LOGS, S3_SERVER_ACCESS_LOGS, ALB_ACCESS_LOGS, ALB_CONNECTION_LOGS, ALB_HEALTH_CHECK_LOGS
      },
      msk_monitoring_parameters: {
        enhanced_monitoring: "DEFAULT", # accepts DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, PER_TOPIC_PER_PARTITION
      },
      kms_key_arn: "KmsKeyArn",
    },
    scope: "String",
    selection_criteria: "String",
    allow_field_updates: false,
    regions: ["Region"],
    all_regions: false,
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_name (required, String) —

    A unique name for the organization-wide telemetry rule being created.

  • :rule (required, Types::TelemetryRule) —

    The configuration details for the organization-wide telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to across the organization.

  • :tags (Hash<String,String>) —

    The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.

Returns:

See Also:



967
968
969
970
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 967

def create_telemetry_rule_for_organization(params = {}, options = {})
  req = build_request(:create_telemetry_rule_for_organization, params)
  req.send_request(options)
end

#delete_centralization_rule_for_organization(params = {}) ⇒ Struct

Deletes an organization-wide centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

Examples:

Request syntax with placeholder values


resp = client.delete_centralization_rule_for_organization({
  rule_identifier: "RuleIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

    The identifier (name or ARN) of the organization centralization rule to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



992
993
994
995
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 992

def delete_centralization_rule_for_organization(params = {}, options = {})
  req = build_request(:delete_centralization_rule_for_organization, params)
  req.send_request(options)
end

#delete_dataset_integration(params = {}) ⇒ Struct

Deletes a dataset integration for the caller's account in the current region. This operation is idempotent; if you submit the same delete more than once, each call succeeds.

Examples:

Request syntax with placeholder values


resp = client.delete_dataset_integration({
  arn: "ResourceArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the dataset integration to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1016
1017
1018
1019
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1016

def delete_dataset_integration(params = {}, options = {})
  req = build_request(:delete_dataset_integration, params)
  req.send_request(options)
end

#delete_s3_table_integration(params = {}) ⇒ Struct

Deletes an S3 Table integration and its associated data. This operation removes the connection between CloudWatch Observability Admin and S3 Tables.

Examples:

Request syntax with placeholder values


resp = client.delete_s3_table_integration({
  arn: "ResourceArn", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the S3 Table integration to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1040
1041
1042
1043
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1040

def delete_s3_table_integration(params = {}, options = {})
  req = build_request(:delete_s3_table_integration, params)
  req.send_request(options)
end

#delete_telemetry_pipeline(params = {}) ⇒ Struct

Deletes a telemetry pipeline and its associated resources. This operation stops data processing and removes the pipeline configuration.

Examples:

Request syntax with placeholder values


resp = client.delete_telemetry_pipeline({
  pipeline_identifier: "TelemetryPipelineIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_identifier (required, String) —

    The ARN of the telemetry pipeline to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1064
1065
1066
1067
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1064

def delete_telemetry_pipeline(params = {}, options = {})
  req = build_request(:delete_telemetry_pipeline, params)
  req.send_request(options)
end

#delete_telemetry_rule(params = {}) ⇒ Struct

Deletes a telemetry rule from your account. Any telemetry configurations previously created by the rule will remain but no new resources will be configured by this rule.

Examples:

Request syntax with placeholder values


resp = client.delete_telemetry_rule({
  rule_identifier: "RuleIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1088
1089
1090
1091
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1088

def delete_telemetry_rule(params = {}, options = {})
  req = build_request(:delete_telemetry_rule, params)
  req.send_request(options)
end

#delete_telemetry_rule_for_organization(params = {}) ⇒ Struct

Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

Examples:

Request syntax with placeholder values


resp = client.delete_telemetry_rule_for_organization({
  rule_identifier: "RuleIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1113
1114
1115
1116
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1113

def delete_telemetry_rule_for_organization(params = {}, options = {})
  req = build_request(:delete_telemetry_rule_for_organization, params)
  req.send_request(options)
end

#get_centralization_rule_for_organization(params = {}) ⇒ Types::GetCentralizationRuleForOrganizationOutput

Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

Examples:

Request syntax with placeholder values


resp = client.get_centralization_rule_for_organization({
  rule_identifier: "RuleIdentifier", # required
})

Response structure


resp.rule_name #=> String
resp.rule_arn #=> String
resp. #=> String
resp.created_time_stamp #=> Integer
resp.created_region #=> String
resp.last_update_time_stamp #=> Integer
resp.rule_health #=> String, one of "Healthy", "Unhealthy", "Provisioning"
resp.failure_reason #=> String, one of "TRUSTED_ACCESS_NOT_ENABLED", "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION", "INTERNAL_SERVER_ERROR"
resp.tag_propagation_status #=> String, one of "Healthy", "Unhealthy"
resp.tag_propagation_failure_reason #=> String, one of "RoleNotAssumable", "RoleLacksPermissions"
resp.context_graph_status #=> String, one of "Healthy", "Unhealthy", "Provisioning"
resp.centralization_rule.source.regions #=> Array
resp.centralization_rule.source.regions[0] #=> String
resp.centralization_rule.source.scope #=> String
resp.centralization_rule.source.source_logs_configuration.log_group_selection_criteria #=> String
resp.centralization_rule.source.source_logs_configuration.data_source_selection_criteria #=> String
resp.centralization_rule.source.source_logs_configuration.encrypted_log_group_strategy #=> String, one of "ALLOW", "SKIP"
resp.centralization_rule.source.source_metrics_configuration.metrics_selection_criteria #=> String
resp.centralization_rule.destination.region #=> String
resp.centralization_rule.destination. #=> String
resp.centralization_rule.destination.destination_logs_configuration.logs_encryption_configuration.encryption_strategy #=> String, one of "CUSTOMER_MANAGED", "AWS_OWNED"
resp.centralization_rule.destination.destination_logs_configuration.logs_encryption_configuration.kms_key_arn #=> String
resp.centralization_rule.destination.destination_logs_configuration.logs_encryption_configuration.encryption_conflict_resolution_strategy #=> String, one of "ALLOW", "SKIP"
resp.centralization_rule.destination.destination_logs_configuration.logs_encryption_configuration.encryption_scope #=> String, one of "ENCRYPTED_SOURCE_ONLY", "NEW_DESTINATION_LOG_GROUPS"
resp.centralization_rule.destination.destination_logs_configuration.backup_configuration.region #=> String
resp.centralization_rule.destination.destination_logs_configuration.backup_configuration.kms_key_arn #=> String
resp.centralization_rule.destination.destination_logs_configuration.log_group_name_configuration.log_group_name_pattern #=> String
resp.centralization_rule.destination.destination_logs_configuration.tag_propagation_configuration.destination_role_arn #=> String
resp.centralization_rule.destination.destination_logs_configuration.tag_propagation_configuration.tag_conflict_resolution_strategy #=> String, one of "IN_SYNC", "ADD_ONLY", "UPDATE_SYNC"
resp.centralization_rule.destination.destination_logs_configuration.log_group_deletion_protection #=> String, one of "ENABLED"
resp.centralization_rule.destination.destination_metrics_configuration.backup_configuration.region #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

    The identifier (name or ARN) of the organization centralization rule to retrieve.

Returns:

See Also:



1185
1186
1187
1188
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1185

def get_centralization_rule_for_organization(params = {}, options = {})
  req = build_request(:get_centralization_rule_for_organization, params)
  req.send_request(options)
end

#get_dataset_integration(params = {}) ⇒ Types::GetDatasetIntegrationOutput

Returns the dataset integration for the caller's account in the current region.

Examples:

Request syntax with placeholder values


resp = client.get_dataset_integration({
  arn: "ResourceArn", # required
})

Response structure


resp.arn #=> String
resp.role_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the dataset integration to retrieve.

Returns:

See Also:



1220
1221
1222
1223
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1220

def get_dataset_integration(params = {}, options = {})
  req = build_request(:get_dataset_integration, params)
  req.send_request(options)
end

#get_s3_table_integration(params = {}) ⇒ Types::GetS3TableIntegrationOutput

Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.

Examples:

Request syntax with placeholder values


resp = client.get_s3_table_integration({
  arn: "ResourceArn", # required
})

Response structure


resp.arn #=> String
resp.role_arn #=> String
resp.status #=> String, one of "ACTIVE", "DELETING"
resp.encryption.sse_algorithm #=> String, one of "aws:kms", "AES256"
resp.encryption.kms_key_arn #=> String
resp.destination_table_bucket_arn #=> String
resp.created_time_stamp #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the S3 Table integration to retrieve.

Returns:

See Also:



1261
1262
1263
1264
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1261

def get_s3_table_integration(params = {}, options = {})
  req = build_request(:get_s3_table_integration, params)
  req.send_request(options)
end

#get_telemetry_enrichment_status(params = {}) ⇒ Types::GetTelemetryEnrichmentStatusOutput

Returns the current status of the resource tags for telemetry feature, which enhances telemetry data with additional resource metadata from Resource Explorer.

Examples:

Response structure


resp.status #=> String, one of "Running", "Stopped", "Impaired"
resp.aws_resource_explorer_managed_view_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1284
1285
1286
1287
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1284

def get_telemetry_enrichment_status(params = {}, options = {})
  req = build_request(:get_telemetry_enrichment_status, params)
  req.send_request(options)
end

#get_telemetry_evaluation_status(params = {}) ⇒ Types::GetTelemetryEvaluationStatusOutput

Returns the current onboarding status of the telemetry config feature, including the status of the feature and reason the feature failed to start or stop.

Examples:

Response structure


resp.status #=> String, one of "NOT_STARTED", "STARTING", "FAILED_START", "RUNNING", "STOPPING", "FAILED_STOP", "STOPPED"
resp.failure_reason #=> String
resp.home_region #=> String
resp.region_statuses #=> Array
resp.region_statuses[0].region #=> String
resp.region_statuses[0].status #=> String
resp.region_statuses[0].failure_reason #=> String
resp.region_statuses[0].rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1315
1316
1317
1318
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1315

def get_telemetry_evaluation_status(params = {}, options = {})
  req = build_request(:get_telemetry_evaluation_status, params)
  req.send_request(options)
end

#get_telemetry_evaluation_status_for_organization(params = {}) ⇒ Types::GetTelemetryEvaluationStatusForOrganizationOutput

This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config.

Examples:

Response structure


resp.status #=> String, one of "NOT_STARTED", "STARTING", "FAILED_START", "RUNNING", "STOPPING", "FAILED_STOP", "STOPPED"
resp.failure_reason #=> String
resp.home_region #=> String
resp.region_statuses #=> Array
resp.region_statuses[0].region #=> String
resp.region_statuses[0].status #=> String
resp.region_statuses[0].failure_reason #=> String
resp.region_statuses[0].rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



1347
1348
1349
1350
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1347

def get_telemetry_evaluation_status_for_organization(params = {}, options = {})
  req = build_request(:get_telemetry_evaluation_status_for_organization, params)
  req.send_request(options)
end

#get_telemetry_pipeline(params = {}) ⇒ Types::GetTelemetryPipelineOutput

Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.

Examples:

Request syntax with placeholder values


resp = client.get_telemetry_pipeline({
  pipeline_identifier: "TelemetryPipelineIdentifier", # required
})

Response structure


resp.pipeline.created_time_stamp #=> Integer
resp.pipeline.last_update_time_stamp #=> Integer
resp.pipeline.arn #=> String
resp.pipeline.name #=> String
resp.pipeline.configuration.body #=> String
resp.pipeline.status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED"
resp.pipeline.status_reason.description #=> String
resp.pipeline.tags #=> Hash
resp.pipeline.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_identifier (required, String) —

    The identifier (name or ARN) of the telemetry pipeline to retrieve.

Returns:

See Also:



1384
1385
1386
1387
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1384

def get_telemetry_pipeline(params = {}, options = {})
  req = build_request(:get_telemetry_pipeline, params)
  req.send_request(options)
end

#get_telemetry_rule(params = {}) ⇒ Types::GetTelemetryRuleOutput

Retrieves the details of a specific telemetry rule in your account.

Examples:

Request syntax with placeholder values


resp = client.get_telemetry_rule({
  rule_identifier: "RuleIdentifier", # required
})

Response structure


resp.rule_name #=> String
resp.rule_arn #=> String
resp.created_time_stamp #=> Integer
resp.last_update_time_stamp #=> Integer
resp.telemetry_rule.resource_type #=> String, one of "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::BedrockAgentCore::PaymentManager", "AWS::SecurityHub::Hub", "AWS::CloudFront::Distribution", "AWS::SecurityHub::HubV2", "AWS::CloudWatch::OTelEnrichment", "AWS::MSK::Cluster", "AWS::S3::Bucket", "AWS::Bedrock::KnowledgeBase", "AWS::XRay::TransactionSearchConfig"
resp.telemetry_rule.telemetry_type #=> String, one of "Logs", "Metrics", "Traces", "Insights"
resp.telemetry_rule.telemetry_source_types #=> Array
resp.telemetry_rule.telemetry_source_types[0] #=> String, one of "VPC_FLOW_LOGS", "ROUTE53_RESOLVER_QUERY_LOGS", "EKS_AUDIT_LOGS", "EKS_AUTHENTICATOR_LOGS", "EKS_CONTROLLER_MANAGER_LOGS", "EKS_SCHEDULER_LOGS", "EKS_API_LOGS"
resp.telemetry_rule.destination_configuration.destination_type #=> String, one of "cloud-watch-logs"
resp.telemetry_rule.destination_configuration.destination_pattern #=> String
resp.telemetry_rule.destination_configuration.retention_in_days #=> Integer
resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.log_format #=> String
resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.traffic_type #=> String
resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.max_aggregation_interval #=> Integer
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].name #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].field #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].equals #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].equals[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].starts_with #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].starts_with[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].ends_with #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].ends_with[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_equals #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_equals[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_starts_with #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_starts_with[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_ends_with #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_ends_with[0] #=> String
resp.telemetry_rule.destination_configuration.elb_load_balancer_logging_parameters.output_format #=> String, one of "plain", "json"
resp.telemetry_rule.destination_configuration.elb_load_balancer_logging_parameters.field_delimiter #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields #=> Array
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields[0].single_header.name #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields[0].uri_path #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields[0].query_string #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields[0].method #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters #=> Array
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].behavior #=> String, one of "KEEP", "DROP"
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].requirement #=> String, one of "MEETS_ALL", "MEETS_ANY"
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].conditions #=> Array
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].conditions[0].action_condition.action #=> String, one of "ALLOW", "BLOCK", "COUNT", "CAPTCHA", "CHALLENGE", "EXCLUDED_AS_COUNT"
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].conditions[0].label_name_condition.label_name #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.default_behavior #=> String, one of "KEEP", "DROP"
resp.telemetry_rule.destination_configuration.waf_logging_parameters.log_type #=> String, one of "WAF_LOGS"
resp.telemetry_rule.destination_configuration.log_delivery_parameters.log_types #=> Array
resp.telemetry_rule.destination_configuration.log_delivery_parameters.log_types[0] #=> String, one of "APPLICATION_LOGS", "USAGE_LOGS", "SECURITY_FINDING_LOGS", "ACCESS_LOGS", "CONNECTION_LOGS", "S3_SERVER_ACCESS_LOGS", "ALB_ACCESS_LOGS", "ALB_CONNECTION_LOGS", "ALB_HEALTH_CHECK_LOGS"
resp.telemetry_rule.destination_configuration.msk_monitoring_parameters.enhanced_monitoring #=> String, one of "DEFAULT", "PER_BROKER", "PER_TOPIC_PER_BROKER", "PER_TOPIC_PER_PARTITION"
resp.telemetry_rule.destination_configuration.kms_key_arn #=> String
resp.telemetry_rule.scope #=> String
resp.telemetry_rule.selection_criteria #=> String
resp.telemetry_rule.allow_field_updates #=> Boolean
resp.telemetry_rule.regions #=> Array
resp.telemetry_rule.regions[0] #=> String
resp.telemetry_rule.all_regions #=> Boolean
resp.home_region #=> String
resp.is_replicated #=> Boolean
resp.region_statuses #=> Array
resp.region_statuses[0].region #=> String
resp.region_statuses[0].status #=> String
resp.region_statuses[0].failure_reason #=> String
resp.region_statuses[0].rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

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

Returns:

See Also:



1480
1481
1482
1483
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1480

def get_telemetry_rule(params = {}, options = {})
  req = build_request(:get_telemetry_rule, params)
  req.send_request(options)
end

#get_telemetry_rule_for_organization(params = {}) ⇒ Types::GetTelemetryRuleForOrganizationOutput

Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

Examples:

Request syntax with placeholder values


resp = client.get_telemetry_rule_for_organization({
  rule_identifier: "RuleIdentifier", # required
})

Response structure


resp.rule_name #=> String
resp.rule_arn #=> String
resp.created_time_stamp #=> Integer
resp.last_update_time_stamp #=> Integer
resp.telemetry_rule.resource_type #=> String, one of "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::BedrockAgentCore::PaymentManager", "AWS::SecurityHub::Hub", "AWS::CloudFront::Distribution", "AWS::SecurityHub::HubV2", "AWS::CloudWatch::OTelEnrichment", "AWS::MSK::Cluster", "AWS::S3::Bucket", "AWS::Bedrock::KnowledgeBase", "AWS::XRay::TransactionSearchConfig"
resp.telemetry_rule.telemetry_type #=> String, one of "Logs", "Metrics", "Traces", "Insights"
resp.telemetry_rule.telemetry_source_types #=> Array
resp.telemetry_rule.telemetry_source_types[0] #=> String, one of "VPC_FLOW_LOGS", "ROUTE53_RESOLVER_QUERY_LOGS", "EKS_AUDIT_LOGS", "EKS_AUTHENTICATOR_LOGS", "EKS_CONTROLLER_MANAGER_LOGS", "EKS_SCHEDULER_LOGS", "EKS_API_LOGS"
resp.telemetry_rule.destination_configuration.destination_type #=> String, one of "cloud-watch-logs"
resp.telemetry_rule.destination_configuration.destination_pattern #=> String
resp.telemetry_rule.destination_configuration.retention_in_days #=> Integer
resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.log_format #=> String
resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.traffic_type #=> String
resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.max_aggregation_interval #=> Integer
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].name #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].field #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].equals #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].equals[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].starts_with #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].starts_with[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].ends_with #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].ends_with[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_equals #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_equals[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_starts_with #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_starts_with[0] #=> String
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_ends_with #=> Array
resp.telemetry_rule.destination_configuration.cloudtrail_parameters.advanced_event_selectors[0].field_selectors[0].not_ends_with[0] #=> String
resp.telemetry_rule.destination_configuration.elb_load_balancer_logging_parameters.output_format #=> String, one of "plain", "json"
resp.telemetry_rule.destination_configuration.elb_load_balancer_logging_parameters.field_delimiter #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields #=> Array
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields[0].single_header.name #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields[0].uri_path #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields[0].query_string #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.redacted_fields[0].method #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters #=> Array
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].behavior #=> String, one of "KEEP", "DROP"
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].requirement #=> String, one of "MEETS_ALL", "MEETS_ANY"
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].conditions #=> Array
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].conditions[0].action_condition.action #=> String, one of "ALLOW", "BLOCK", "COUNT", "CAPTCHA", "CHALLENGE", "EXCLUDED_AS_COUNT"
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.filters[0].conditions[0].label_name_condition.label_name #=> String
resp.telemetry_rule.destination_configuration.waf_logging_parameters.logging_filter.default_behavior #=> String, one of "KEEP", "DROP"
resp.telemetry_rule.destination_configuration.waf_logging_parameters.log_type #=> String, one of "WAF_LOGS"
resp.telemetry_rule.destination_configuration.log_delivery_parameters.log_types #=> Array
resp.telemetry_rule.destination_configuration.log_delivery_parameters.log_types[0] #=> String, one of "APPLICATION_LOGS", "USAGE_LOGS", "SECURITY_FINDING_LOGS", "ACCESS_LOGS", "CONNECTION_LOGS", "S3_SERVER_ACCESS_LOGS", "ALB_ACCESS_LOGS", "ALB_CONNECTION_LOGS", "ALB_HEALTH_CHECK_LOGS"
resp.telemetry_rule.destination_configuration.msk_monitoring_parameters.enhanced_monitoring #=> String, one of "DEFAULT", "PER_BROKER", "PER_TOPIC_PER_BROKER", "PER_TOPIC_PER_PARTITION"
resp.telemetry_rule.destination_configuration.kms_key_arn #=> String
resp.telemetry_rule.scope #=> String
resp.telemetry_rule.selection_criteria #=> String
resp.telemetry_rule.allow_field_updates #=> Boolean
resp.telemetry_rule.regions #=> Array
resp.telemetry_rule.regions[0] #=> String
resp.telemetry_rule.all_regions #=> Boolean
resp.home_region #=> String
resp.is_replicated #=> Boolean
resp.region_statuses #=> Array
resp.region_statuses[0].region #=> String
resp.region_statuses[0].status #=> String
resp.region_statuses[0].failure_reason #=> String
resp.region_statuses[0].rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

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

Returns:

See Also:



1579
1580
1581
1582
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1579

def get_telemetry_rule_for_organization(params = {}, options = {})
  req = build_request(:get_telemetry_rule_for_organization, params)
  req.send_request(options)
end

#list_centralization_rules_for_organization(params = {}) ⇒ Types::ListCentralizationRulesForOrganizationOutput

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_centralization_rules_for_organization({
  rule_name_prefix: "ListCentralizationRulesForOrganizationInputRuleNamePrefixString",
  all_regions: false,
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.centralization_rule_summaries #=> Array
resp.centralization_rule_summaries[0].rule_name #=> String
resp.centralization_rule_summaries[0].rule_arn #=> String
resp.centralization_rule_summaries[0]. #=> String
resp.centralization_rule_summaries[0].created_time_stamp #=> Integer
resp.centralization_rule_summaries[0].created_region #=> String
resp.centralization_rule_summaries[0].last_update_time_stamp #=> Integer
resp.centralization_rule_summaries[0].rule_health #=> String, one of "Healthy", "Unhealthy", "Provisioning"
resp.centralization_rule_summaries[0].failure_reason #=> String, one of "TRUSTED_ACCESS_NOT_ENABLED", "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION", "INTERNAL_SERVER_ERROR"
resp.centralization_rule_summaries[0].tag_propagation_status #=> String, one of "Healthy", "Unhealthy"
resp.centralization_rule_summaries[0].tag_propagation_failure_reason #=> String, one of "RoleNotAssumable", "RoleLacksPermissions"
resp.centralization_rule_summaries[0].context_graph_status #=> String, one of "Healthy", "Unhealthy", "Provisioning"
resp.centralization_rule_summaries[0]. #=> String
resp.centralization_rule_summaries[0].destination_region #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_name_prefix (String) —

    A string to filter organization centralization rules whose names begin with the specified prefix.

  • :all_regions (Boolean) —

    A flag determining whether to return organization centralization rules from all regions or only the current region.

  • :max_results (Integer) —

    The maximum number of organization centralization rules to return in a single call.

  • :next_token (String) —

    The token for the next set of results. A previous call generates this token.

Returns:

See Also:



1642
1643
1644
1645
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1642

def list_centralization_rules_for_organization(params = {}, options = {})
  req = build_request(:list_centralization_rules_for_organization, params)
  req.send_request(options)
end

#list_dataset_integrations(params = {}) ⇒ Types::ListDatasetIntegrationsOutput

Returns the dataset integrations in your account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_dataset_integrations({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.dataset_integration_summaries #=> Array
resp.dataset_integration_summaries[0].arn #=> String
resp.dataset_integration_summaries[0].role_arn #=> String
resp.dataset_integration_summaries[0].created_at #=> Time
resp.dataset_integration_summaries[0].updated_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The token for the next set of results. A previous call generates this token.

Returns:

See Also:



1683
1684
1685
1686
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1683

def list_dataset_integrations(params = {}, options = {})
  req = build_request(:list_dataset_integrations, params)
  req.send_request(options)
end

#list_resource_telemetry(params = {}) ⇒ Types::ListResourceTelemetryOutput

Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config. For more information, see Auditing CloudWatch telemetry configurations.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resource_telemetry({
  resource_identifier_prefix: "ResourceIdentifierPrefix",
  resource_types: ["AWS::EC2::Instance"], # accepts 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::BedrockAgentCore::PaymentManager, AWS::SecurityHub::Hub, AWS::CloudFront::Distribution, AWS::SecurityHub::HubV2, AWS::CloudWatch::OTelEnrichment, AWS::MSK::Cluster, AWS::S3::Bucket, AWS::Bedrock::KnowledgeBase, AWS::XRay::TransactionSearchConfig
  telemetry_configuration_state: {
    "Logs" => "Enabled", # accepts Enabled, Disabled, NotApplicable
  },
  resource_tags: {
    "TagKey" => "TagValue",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.telemetry_configurations #=> Array
resp.telemetry_configurations[0]. #=> String
resp.telemetry_configurations[0].telemetry_configuration_state #=> Hash
resp.telemetry_configurations[0].telemetry_configuration_state["TelemetryType"] #=> String, one of "Enabled", "Disabled", "NotApplicable"
resp.telemetry_configurations[0].resource_type #=> String, one of "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::BedrockAgentCore::PaymentManager", "AWS::SecurityHub::Hub", "AWS::CloudFront::Distribution", "AWS::SecurityHub::HubV2", "AWS::CloudWatch::OTelEnrichment", "AWS::MSK::Cluster", "AWS::S3::Bucket", "AWS::Bedrock::KnowledgeBase", "AWS::XRay::TransactionSearchConfig"
resp.telemetry_configurations[0].resource_identifier #=> String
resp.telemetry_configurations[0].resource_tags #=> Hash
resp.telemetry_configurations[0].resource_tags["String"] #=> String
resp.telemetry_configurations[0].last_update_time_stamp #=> Integer
resp.telemetry_configurations[0].telemetry_source_type #=> String, one of "VPC_FLOW_LOGS", "ROUTE53_RESOLVER_QUERY_LOGS", "EKS_AUDIT_LOGS", "EKS_AUTHENTICATOR_LOGS", "EKS_CONTROLLER_MANAGER_LOGS", "EKS_SCHEDULER_LOGS", "EKS_API_LOGS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_identifier_prefix (String) —

    A string used to filter resources which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.

  • :resource_types (Array<String>) —

    A list of resource types used to filter resources supported by telemetry config. If this parameter is provided, the service returns the resources in the same order as specified in the request. Currently supported resource types for discovery are:

    • AWS::EC2::Instance

    • AWS::EC2::VPC

    • AWS::Lambda::Function

    • AWS::EKS::Cluster

    • AWS::WAFv2::WebACL

    • AWS::ElasticLoadBalancingV2::LoadBalancer (Network Load Balancers only)

  • :telemetry_configuration_state (Hash<String,String>) —

    A key-value pair to filter resources based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

  • :resource_tags (Hash<String,String>) —

    A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags?

  • :max_results (Integer) —

    A number field used to limit the number of results within the returned list.

  • :next_token (String) —

    The token for the next set of items to return. A previous call generates this token.

Returns:

See Also:



1780
1781
1782
1783
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1780

def list_resource_telemetry(params = {}, options = {})
  req = build_request(:list_resource_telemetry, params)
  req.send_request(options)
end

#list_resource_telemetry_for_organization(params = {}) ⇒ Types::ListResourceTelemetryForOrganizationOutput

Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config in the organization.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resource_telemetry_for_organization({
  account_identifiers: ["AccountIdentifier"],
  resource_identifier_prefix: "ResourceIdentifierPrefix",
  resource_types: ["AWS::EC2::Instance"], # accepts 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::BedrockAgentCore::PaymentManager, AWS::SecurityHub::Hub, AWS::CloudFront::Distribution, AWS::SecurityHub::HubV2, AWS::CloudWatch::OTelEnrichment, AWS::MSK::Cluster, AWS::S3::Bucket, AWS::Bedrock::KnowledgeBase, AWS::XRay::TransactionSearchConfig
  telemetry_configuration_state: {
    "Logs" => "Enabled", # accepts Enabled, Disabled, NotApplicable
  },
  resource_tags: {
    "TagKey" => "TagValue",
  },
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.telemetry_configurations #=> Array
resp.telemetry_configurations[0]. #=> String
resp.telemetry_configurations[0].telemetry_configuration_state #=> Hash
resp.telemetry_configurations[0].telemetry_configuration_state["TelemetryType"] #=> String, one of "Enabled", "Disabled", "NotApplicable"
resp.telemetry_configurations[0].resource_type #=> String, one of "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::BedrockAgentCore::PaymentManager", "AWS::SecurityHub::Hub", "AWS::CloudFront::Distribution", "AWS::SecurityHub::HubV2", "AWS::CloudWatch::OTelEnrichment", "AWS::MSK::Cluster", "AWS::S3::Bucket", "AWS::Bedrock::KnowledgeBase", "AWS::XRay::TransactionSearchConfig"
resp.telemetry_configurations[0].resource_identifier #=> String
resp.telemetry_configurations[0].resource_tags #=> Hash
resp.telemetry_configurations[0].resource_tags["String"] #=> String
resp.telemetry_configurations[0].last_update_time_stamp #=> Integer
resp.telemetry_configurations[0].telemetry_source_type #=> String, one of "VPC_FLOW_LOGS", "ROUTE53_RESOLVER_QUERY_LOGS", "EKS_AUDIT_LOGS", "EKS_AUTHENTICATOR_LOGS", "EKS_CONTROLLER_MANAGER_LOGS", "EKS_SCHEDULER_LOGS", "EKS_API_LOGS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_identifiers (Array<String>) —

    A list of Amazon Web Services accounts used to filter the resources to those associated with the specified accounts.

  • :resource_identifier_prefix (String) —

    A string used to filter resources in the organization which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.

  • :resource_types (Array<String>) —

    A list of resource types used to filter resources in the organization. If this parameter is provided, the service returns the resources in the same order as specified in the request. Currently supported resource types for discovery are:

    • AWS::EC2::Instance

    • AWS::EC2::VPC

    • AWS::Lambda::Function

    • AWS::EKS::Cluster

    • AWS::WAFv2::WebACL

    • AWS::ElasticLoadBalancingV2::LoadBalancer (Network Load Balancers only)

  • :telemetry_configuration_state (Hash<String,String>) —

    A key-value pair to filter resources in the organization based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

  • :resource_tags (Hash<String,String>) —

    A key-value pair to filter resources in the organization based on tags associated with the resource. Fore more information about tags, see What are tags?

  • :max_results (Integer) —

    A number field used to limit the number of results within the returned list.

  • :next_token (String) —

    The token for the next set of items to return. A previous call provides this token.

Returns:

See Also:



1878
1879
1880
1881
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1878

def list_resource_telemetry_for_organization(params = {}, options = {})
  req = build_request(:list_resource_telemetry_for_organization, params)
  req.send_request(options)
end

#list_s3_table_integrations(params = {}) ⇒ Types::ListS3TableIntegrationsOutput

Lists all S3 Table integrations in your account. We recommend using pagination to ensure that the operation returns quickly and successfully.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_s3_table_integrations({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.integration_summaries #=> Array
resp.integration_summaries[0].arn #=> String
resp.integration_summaries[0].status #=> String, one of "ACTIVE", "DELETING"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of S3 Table integrations to return in a single call.

  • :next_token (String) —

    The token for the next set of results. A previous call generates this token.

Returns:

See Also:



1920
1921
1922
1923
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1920

def list_s3_table_integrations(params = {}, options = {})
  req = build_request(:list_s3_table_integrations, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput

Lists all tags attached to the specified resource. Supports telemetry rule resources and telemetry pipeline resources.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the telemetry rule resource whose tags you want to list.

Returns:

See Also:



1951
1952
1953
1954
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1951

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#list_telemetry_pipelines(params = {}) ⇒ Types::ListTelemetryPipelinesOutput

Returns a list of telemetry pipelines in your account. Returns up to 100 results. If more than 100 telemetry pipelines exist, include the NextToken value from the response to retrieve the next set of results.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_telemetry_pipelines({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.pipeline_summaries #=> Array
resp.pipeline_summaries[0].created_time_stamp #=> Integer
resp.pipeline_summaries[0].last_update_time_stamp #=> Integer
resp.pipeline_summaries[0].arn #=> String
resp.pipeline_summaries[0].name #=> String
resp.pipeline_summaries[0].status #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATE_FAILED", "UPDATE_FAILED"
resp.pipeline_summaries[0].tags #=> Hash
resp.pipeline_summaries[0].tags["String"] #=> String
resp.pipeline_summaries[0].configuration_summary.sources #=> Array
resp.pipeline_summaries[0].configuration_summary.sources[0].type #=> String
resp.pipeline_summaries[0].configuration_summary.data_sources #=> Array
resp.pipeline_summaries[0].configuration_summary.data_sources[0].name #=> String
resp.pipeline_summaries[0].configuration_summary.data_sources[0].type #=> String
resp.pipeline_summaries[0].configuration_summary.processors #=> Array
resp.pipeline_summaries[0].configuration_summary.processors[0] #=> String
resp.pipeline_summaries[0].configuration_summary.processor_count #=> Integer
resp.pipeline_summaries[0].configuration_summary.sinks #=> Array
resp.pipeline_summaries[0].configuration_summary.sinks[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of telemetry pipelines to return in a single call.

  • :next_token (String) —

    The token for the next set of results. A previous call generates this token.

Returns:

See Also:



2008
2009
2010
2011
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2008

def list_telemetry_pipelines(params = {}, options = {})
  req = build_request(:list_telemetry_pipelines, params)
  req.send_request(options)
end

#list_telemetry_rules(params = {}) ⇒ Types::ListTelemetryRulesOutput

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_telemetry_rules({
  rule_name_prefix: "String",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.telemetry_rule_summaries #=> Array
resp.telemetry_rule_summaries[0].rule_name #=> String
resp.telemetry_rule_summaries[0].rule_arn #=> String
resp.telemetry_rule_summaries[0].created_time_stamp #=> Integer
resp.telemetry_rule_summaries[0].last_update_time_stamp #=> Integer
resp.telemetry_rule_summaries[0].resource_type #=> String, one of "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::BedrockAgentCore::PaymentManager", "AWS::SecurityHub::Hub", "AWS::CloudFront::Distribution", "AWS::SecurityHub::HubV2", "AWS::CloudWatch::OTelEnrichment", "AWS::MSK::Cluster", "AWS::S3::Bucket", "AWS::Bedrock::KnowledgeBase", "AWS::XRay::TransactionSearchConfig"
resp.telemetry_rule_summaries[0].telemetry_type #=> String, one of "Logs", "Metrics", "Traces", "Insights"
resp.telemetry_rule_summaries[0].telemetry_source_types #=> Array
resp.telemetry_rule_summaries[0].telemetry_source_types[0] #=> String, one of "VPC_FLOW_LOGS", "ROUTE53_RESOLVER_QUERY_LOGS", "EKS_AUDIT_LOGS", "EKS_AUTHENTICATOR_LOGS", "EKS_CONTROLLER_MANAGER_LOGS", "EKS_SCHEDULER_LOGS", "EKS_API_LOGS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_name_prefix (String) —

    A string to filter telemetry rules whose names begin with the specified prefix.

  • :max_results (Integer) —

    The maximum number of telemetry rules to return in a single call.

  • :next_token (String) —

    The token for the next set of results. A previous call generates this token.

Returns:

See Also:



2059
2060
2061
2062
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2059

def list_telemetry_rules(params = {}, options = {})
  req = build_request(:list_telemetry_rules, params)
  req.send_request(options)
end

#list_telemetry_rules_for_organization(params = {}) ⇒ Types::ListTelemetryRulesForOrganizationOutput

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_telemetry_rules_for_organization({
  rule_name_prefix: "String",
  source_account_ids: ["AccountIdentifier"],
  source_organization_unit_ids: ["OrganizationUnitIdentifier"],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.telemetry_rule_summaries #=> Array
resp.telemetry_rule_summaries[0].rule_name #=> String
resp.telemetry_rule_summaries[0].rule_arn #=> String
resp.telemetry_rule_summaries[0].created_time_stamp #=> Integer
resp.telemetry_rule_summaries[0].last_update_time_stamp #=> Integer
resp.telemetry_rule_summaries[0].resource_type #=> String, one of "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::BedrockAgentCore::PaymentManager", "AWS::SecurityHub::Hub", "AWS::CloudFront::Distribution", "AWS::SecurityHub::HubV2", "AWS::CloudWatch::OTelEnrichment", "AWS::MSK::Cluster", "AWS::S3::Bucket", "AWS::Bedrock::KnowledgeBase", "AWS::XRay::TransactionSearchConfig"
resp.telemetry_rule_summaries[0].telemetry_type #=> String, one of "Logs", "Metrics", "Traces", "Insights"
resp.telemetry_rule_summaries[0].telemetry_source_types #=> Array
resp.telemetry_rule_summaries[0].telemetry_source_types[0] #=> String, one of "VPC_FLOW_LOGS", "ROUTE53_RESOLVER_QUERY_LOGS", "EKS_AUDIT_LOGS", "EKS_AUTHENTICATOR_LOGS", "EKS_CONTROLLER_MANAGER_LOGS", "EKS_SCHEDULER_LOGS", "EKS_API_LOGS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_name_prefix (String) —

    A string to filter organization telemetry rules whose names begin with the specified prefix.

  • :source_account_ids (Array<String>) —

    The list of account IDs to filter organization telemetry rules by their source accounts.

  • :source_organization_unit_ids (Array<String>) —

    The list of organizational unit IDs to filter organization telemetry rules by their source organizational units.

  • :max_results (Integer) —

    The maximum number of organization telemetry rules to return in a single call.

  • :next_token (String) —

    The token for the next set of results. A previous call generates this token.

Returns:

See Also:



2122
2123
2124
2125
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2122

def list_telemetry_rules_for_organization(params = {}, options = {})
  req = build_request(:list_telemetry_rules_for_organization, params)
  req.send_request(options)
end

#start_telemetry_enrichment(params = {}) ⇒ Types::StartTelemetryEnrichmentOutput

Enables the resource tags for telemetry feature for your account, which enhances telemetry data with additional resource metadata from Resource Explorer to provide richer context for monitoring and observability.

Examples:

Response structure


resp.status #=> String, one of "Running", "Stopped", "Impaired"
resp.aws_resource_explorer_managed_view_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2146
2147
2148
2149
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2146

def start_telemetry_enrichment(params = {}, options = {})
  req = build_request(:start_telemetry_enrichment, params)
  req.send_request(options)
end

#start_telemetry_evaluation(params = {}) ⇒ Struct

This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.

Examples:

Request syntax with placeholder values


resp = client.start_telemetry_evaluation({
  regions: ["Region"],
  all_regions: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :regions (Array<String>) —

    An optional list of Amazon Web Services Regions to include in multi-region telemetry evaluation. The current region is always implicitly included and must not be specified in this list. When provided, telemetry evaluation starts in the current region and propagates to all specified regions. Mutually exclusive with AllRegions. If neither Regions nor AllRegions is provided, the operation applies only to the current region.

  • :all_regions (Boolean) —

    If set to true, telemetry evaluation starts in all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. The current region becomes the home region for managing multi-region evaluation. When new regions become available, evaluation automatically expands to include them. Mutually exclusive with Regions.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2184
2185
2186
2187
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2184

def start_telemetry_evaluation(params = {}, options = {})
  req = build_request(:start_telemetry_evaluation, params)
  req.send_request(options)
end

#start_telemetry_evaluation_for_organization(params = {}) ⇒ Struct

This actions begins onboarding the organization and all member accounts to the telemetry config feature.

Examples:

Request syntax with placeholder values


resp = client.start_telemetry_evaluation_for_organization({
  regions: ["Region"],
  all_regions: false,
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :regions (Array<String>) —

    An optional list of Amazon Web Services Regions to include in multi-region telemetry evaluation for the organization. The current region is always implicitly included and must not be specified in this list. When provided, telemetry evaluation starts in the current region and propagates to all specified regions for the organization. Mutually exclusive with AllRegions. If neither Regions nor AllRegions is provided, the operation applies only to the current region.

  • :all_regions (Boolean) —

    If set to true, telemetry evaluation for the organization starts in all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. The current region becomes the home region for managing multi-region evaluation for the organization. When new regions become available, evaluation automatically expands to include them. Mutually exclusive with Regions.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2223
2224
2225
2226
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2223

def start_telemetry_evaluation_for_organization(params = {}, options = {})
  req = build_request(:start_telemetry_evaluation_for_organization, params)
  req.send_request(options)
end

#stop_telemetry_enrichment(params = {}) ⇒ Types::StopTelemetryEnrichmentOutput

Disables the resource tags for telemetry feature for your account, stopping the enhancement of telemetry data with additional resource metadata.

Examples:

Response structure


resp.status #=> String, one of "Running", "Stopped", "Impaired"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

See Also:



2244
2245
2246
2247
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2244

def stop_telemetry_enrichment(params = {}, options = {})
  req = build_request(:stop_telemetry_enrichment, params)
  req.send_request(options)
end

#stop_telemetry_evaluation(params = {}) ⇒ Struct

This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2258
2259
2260
2261
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2258

def stop_telemetry_evaluation(params = {}, options = {})
  req = build_request(:stop_telemetry_evaluation, params)
  req.send_request(options)
end

#stop_telemetry_evaluation_for_organization(params = {}) ⇒ Struct

This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2272
2273
2274
2275
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2272

def stop_telemetry_evaluation_for_organization(params = {}, options = {})
  req = build_request(:stop_telemetry_evaluation_for_organization, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds or updates tags for a resource. Supports telemetry rule resources and telemetry pipeline resources.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

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

  • :tags (required, Hash<String,String>) —

    The key-value pairs to add or update for the telemetry rule resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2301
2302
2303
2304
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2301

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#test_telemetry_pipeline(params = {}) ⇒ Types::TestTelemetryPipelineOutput

Tests a pipeline configuration with sample records to validate data processing before deployment. This operation helps ensure your pipeline configuration works as expected.

Examples:

Request syntax with placeholder values


resp = client.test_telemetry_pipeline({
  records: [ # required
    {
      data: "String",
      type: "STRING", # accepts STRING, JSON
    },
  ],
  configuration: { # required
    body: "TelemetryPipelineConfigurationBody", # required
  },
  signal_type: "LOG", # accepts LOG, METRIC
})

Response structure


resp.results #=> Array
resp.results[0].record.data #=> String
resp.results[0].record.type #=> String, one of "STRING", "JSON"
resp.results[0].error.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :records (required, Array<Types::Record>) —

    The sample records to process through the pipeline configuration for testing purposes.

  • :configuration (required, Types::TelemetryPipelineConfiguration) —

    The pipeline configuration to test with the provided sample records.

  • :signal_type (String) —

    The type of telemetry signal to test. If not specified, defaults to log processing.

Returns:

See Also:



2351
2352
2353
2354
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2351

def test_telemetry_pipeline(params = {}, options = {})
  req = build_request(:test_telemetry_pipeline, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from a resource. Supports telemetry rule resources and telemetry pipeline resources.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the telemetry rule resource to remove tags from.

  • :tag_keys (required, Array<String>) —

    The list of tag keys to remove from the telemetry rule resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2379
2380
2381
2382
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2379

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_centralization_rule_for_organization(params = {}) ⇒ Types::UpdateCentralizationRuleForOrganizationOutput

Updates an existing centralization rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Examples:

Request syntax with placeholder values


resp = client.update_centralization_rule_for_organization({
  rule_identifier: "RuleIdentifier", # required
  rule: { # required
    source: { # required
      regions: ["Region"], # required
      scope: "SourceFilterString",
      source_logs_configuration: {
        log_group_selection_criteria: "LogsFilterString",
        data_source_selection_criteria: "DataSourceFilterString",
        encrypted_log_group_strategy: "ALLOW", # required, accepts ALLOW, SKIP
      },
      source_metrics_configuration: {
        metrics_selection_criteria: "MetricsFilterString",
      },
      source_context_graph_configuration: {
      },
    },
    destination: { # required
      region: "Region", # required
      account: "AccountIdentifier",
      destination_logs_configuration: {
        logs_encryption_configuration: {
          encryption_strategy: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, AWS_OWNED
          kms_key_arn: "ResourceArn",
          encryption_conflict_resolution_strategy: "ALLOW", # accepts ALLOW, SKIP
          encryption_scope: "ENCRYPTED_SOURCE_ONLY", # accepts ENCRYPTED_SOURCE_ONLY, NEW_DESTINATION_LOG_GROUPS
        },
        backup_configuration: {
          region: "Region", # required
          kms_key_arn: "ResourceArn",
        },
        log_group_name_configuration: {
          log_group_name_pattern: "LogGroupNamePattern", # required
        },
        tag_propagation_configuration: {
          destination_role_arn: "IamRoleArn", # required
          tag_conflict_resolution_strategy: "IN_SYNC", # accepts IN_SYNC, ADD_ONLY, UPDATE_SYNC
        },
        log_group_deletion_protection: "ENABLED", # accepts ENABLED
      },
      destination_metrics_configuration: {
        backup_configuration: {
          region: "Region", # required
        },
      },
    },
  },
})

Response structure


resp.rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

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

  • :rule (required, Types::CentralizationRule) —

    The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.

Returns:

See Also:



2461
2462
2463
2464
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2461

def update_centralization_rule_for_organization(params = {}, options = {})
  req = build_request(:update_centralization_rule_for_organization, params)
  req.send_request(options)
end

#update_dataset_integration(params = {}) ⇒ Types::UpdateDatasetIntegrationOutput

Updates a dataset integration for the caller's account in the current region. This operation is idempotent; if you submit the same update more than once, each call succeeds.

Examples:

Request syntax with placeholder values


resp = client.update_dataset_integration({
  arn: "ResourceArn", # required
  role_arn: "ResourceArn", # required
})

Response structure


resp.arn #=> String
resp.role_arn #=> String
resp.created_at #=> Time
resp.updated_at #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    The Amazon Resource Name (ARN) of the dataset integration to update.

  • :role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role to associate with the dataset integration.

Returns:

See Also:



2502
2503
2504
2505
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2502

def update_dataset_integration(params = {}, options = {})
  req = build_request(:update_dataset_integration, params)
  req.send_request(options)
end

#update_telemetry_pipeline(params = {}) ⇒ Struct

Updates the configuration of an existing telemetry pipeline.

The following attributes cannot be updated after pipeline creation:

  • Pipeline name - The pipeline name is immutable

  • Pipeline ARN - The ARN is automatically generated and cannot be changed

  • Source type - Once a pipeline is created with a specific source type (such as S3, CloudWatch Logs, GitHub, or third-party sources), it cannot be changed to a different source type

Processors can be added, removed, or modified. However, some processors are not supported for third-party pipelines and cannot be added through updates.

Source-Specific Update Rules

CloudWatch Logs Sources (Vended and Custom)

Updatable: sts_role_arn

Fixed: data_source_name, data_source_type, sink (must remain @original)

S3 Sources (Crowdstrike, Zscaler, SentinelOne, Custom)

Updatable: All SQS configuration parameters, sts_role_arn, codec settings, compression type, bucket ownership settings, sink log group

Fixed: notification_type, aws.region

GitHub Audit Logs

Updatable: All Amazon Web Services Secrets Manager attributes, scope (can switch between ORGANIZATION/ENTERPRISE), organization or enterprise name, range, authentication credentials (PAT or GitHub App)

Microsoft Sources (Entra ID, Office365, Windows)

Updatable: All Amazon Web Services Secrets Manager attributes, tenant_id, workspace_id (Windows only), OAuth2 credentials (client_id, client_secret)

Okta Sources (SSO, Auth0)

Updatable: All Amazon Web Services Secrets Manager attributes, domain, range, OAuth2 credentials (client_id, client_secret)

Palo Alto Networks

Updatable: All Amazon Web Services Secrets Manager attributes, hostname, basic authentication credentials (username, password)

ServiceNow CMDB

Updatable: All Amazon Web Services Secrets Manager attributes, instance_url, range, OAuth2 credentials (client_id, client_secret)

Wiz CNAPP

Updatable: All Amazon Web Services Secrets Manager attributes, region, range, OAuth2 credentials (client_id, client_secret)

Examples:

Request syntax with placeholder values


resp = client.update_telemetry_pipeline({
  pipeline_identifier: "TelemetryPipelineIdentifier", # required
  configuration: { # required
    body: "TelemetryPipelineConfigurationBody", # required
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :pipeline_identifier (required, String) —

    The ARN of the telemetry pipeline to update.

  • :configuration (required, Types::TelemetryPipelineConfiguration) —

    The new configuration for the telemetry pipeline, including updated sources, processors, and destinations.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2600
2601
2602
2603
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2600

def update_telemetry_pipeline(params = {}, options = {})
  req = build_request(:update_telemetry_pipeline, params)
  req.send_request(options)
end

#update_telemetry_rule(params = {}) ⇒ Types::UpdateTelemetryRuleOutput

Updates an existing telemetry rule in your account. If multiple users attempt to modify the same telemetry rule simultaneously, a ConflictException is returned to provide specific error information for concurrent modification scenarios.

Examples:

Request syntax with placeholder values


resp = client.update_telemetry_rule({
  rule_identifier: "RuleIdentifier", # required
  rule: { # required
    resource_type: "AWS::EC2::Instance", # accepts 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::BedrockAgentCore::PaymentManager, AWS::SecurityHub::Hub, AWS::CloudFront::Distribution, AWS::SecurityHub::HubV2, AWS::CloudWatch::OTelEnrichment, AWS::MSK::Cluster, AWS::S3::Bucket, AWS::Bedrock::KnowledgeBase, AWS::XRay::TransactionSearchConfig
    telemetry_type: "Logs", # required, accepts Logs, Metrics, Traces, Insights
    telemetry_source_types: ["VPC_FLOW_LOGS"], # accepts VPC_FLOW_LOGS, ROUTE53_RESOLVER_QUERY_LOGS, EKS_AUDIT_LOGS, EKS_AUTHENTICATOR_LOGS, EKS_CONTROLLER_MANAGER_LOGS, EKS_SCHEDULER_LOGS, EKS_API_LOGS
    destination_configuration: {
      destination_type: "cloud-watch-logs", # accepts cloud-watch-logs
      destination_pattern: "String",
      retention_in_days: 1,
      vpc_flow_log_parameters: {
        log_format: "String",
        traffic_type: "String",
        max_aggregation_interval: 1,
      },
      cloudtrail_parameters: {
        advanced_event_selectors: [ # required
          {
            name: "String",
            field_selectors: [ # required
              {
                field: "String", # required
                equals: ["String"],
                starts_with: ["String"],
                ends_with: ["String"],
                not_equals: ["String"],
                not_starts_with: ["String"],
                not_ends_with: ["String"],
              },
            ],
          },
        ],
      },
      elb_load_balancer_logging_parameters: {
        output_format: "plain", # accepts plain, json
        field_delimiter: "String",
      },
      waf_logging_parameters: {
        redacted_fields: [
          {
            single_header: {
              name: "SingleHeaderNameString",
            },
            uri_path: "String",
            query_string: "String",
            method: "String",
          },
        ],
        logging_filter: {
          filters: [
            {
              behavior: "KEEP", # accepts KEEP, DROP
              requirement: "MEETS_ALL", # accepts MEETS_ALL, MEETS_ANY
              conditions: [
                {
                  action_condition: {
                    action: "ALLOW", # accepts ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE, EXCLUDED_AS_COUNT
                  },
                  label_name_condition: {
                    label_name: "LabelNameConditionLabelNameString",
                  },
                },
              ],
            },
          ],
          default_behavior: "KEEP", # accepts KEEP, DROP
        },
        log_type: "WAF_LOGS", # accepts WAF_LOGS
      },
      log_delivery_parameters: {
        log_types: ["APPLICATION_LOGS"], # accepts APPLICATION_LOGS, USAGE_LOGS, SECURITY_FINDING_LOGS, ACCESS_LOGS, CONNECTION_LOGS, S3_SERVER_ACCESS_LOGS, ALB_ACCESS_LOGS, ALB_CONNECTION_LOGS, ALB_HEALTH_CHECK_LOGS
      },
      msk_monitoring_parameters: {
        enhanced_monitoring: "DEFAULT", # accepts DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, PER_TOPIC_PER_PARTITION
      },
      kms_key_arn: "KmsKeyArn",
    },
    scope: "String",
    selection_criteria: "String",
    allow_field_updates: false,
    regions: ["Region"],
    all_regions: false,
  },
})

Response structure


resp.rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

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

  • :rule (required, Types::TelemetryRule) —

    The new configuration details for the telemetry rule.

Returns:

See Also:



2715
2716
2717
2718
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2715

def update_telemetry_rule(params = {}, options = {})
  req = build_request(:update_telemetry_rule, params)
  req.send_request(options)
end

#update_telemetry_rule_for_organization(params = {}) ⇒ Types::UpdateTelemetryRuleForOrganizationOutput

Updates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

Examples:

Request syntax with placeholder values


resp = client.update_telemetry_rule_for_organization({
  rule_identifier: "RuleIdentifier", # required
  rule: { # required
    resource_type: "AWS::EC2::Instance", # accepts 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::BedrockAgentCore::PaymentManager, AWS::SecurityHub::Hub, AWS::CloudFront::Distribution, AWS::SecurityHub::HubV2, AWS::CloudWatch::OTelEnrichment, AWS::MSK::Cluster, AWS::S3::Bucket, AWS::Bedrock::KnowledgeBase, AWS::XRay::TransactionSearchConfig
    telemetry_type: "Logs", # required, accepts Logs, Metrics, Traces, Insights
    telemetry_source_types: ["VPC_FLOW_LOGS"], # accepts VPC_FLOW_LOGS, ROUTE53_RESOLVER_QUERY_LOGS, EKS_AUDIT_LOGS, EKS_AUTHENTICATOR_LOGS, EKS_CONTROLLER_MANAGER_LOGS, EKS_SCHEDULER_LOGS, EKS_API_LOGS
    destination_configuration: {
      destination_type: "cloud-watch-logs", # accepts cloud-watch-logs
      destination_pattern: "String",
      retention_in_days: 1,
      vpc_flow_log_parameters: {
        log_format: "String",
        traffic_type: "String",
        max_aggregation_interval: 1,
      },
      cloudtrail_parameters: {
        advanced_event_selectors: [ # required
          {
            name: "String",
            field_selectors: [ # required
              {
                field: "String", # required
                equals: ["String"],
                starts_with: ["String"],
                ends_with: ["String"],
                not_equals: ["String"],
                not_starts_with: ["String"],
                not_ends_with: ["String"],
              },
            ],
          },
        ],
      },
      elb_load_balancer_logging_parameters: {
        output_format: "plain", # accepts plain, json
        field_delimiter: "String",
      },
      waf_logging_parameters: {
        redacted_fields: [
          {
            single_header: {
              name: "SingleHeaderNameString",
            },
            uri_path: "String",
            query_string: "String",
            method: "String",
          },
        ],
        logging_filter: {
          filters: [
            {
              behavior: "KEEP", # accepts KEEP, DROP
              requirement: "MEETS_ALL", # accepts MEETS_ALL, MEETS_ANY
              conditions: [
                {
                  action_condition: {
                    action: "ALLOW", # accepts ALLOW, BLOCK, COUNT, CAPTCHA, CHALLENGE, EXCLUDED_AS_COUNT
                  },
                  label_name_condition: {
                    label_name: "LabelNameConditionLabelNameString",
                  },
                },
              ],
            },
          ],
          default_behavior: "KEEP", # accepts KEEP, DROP
        },
        log_type: "WAF_LOGS", # accepts WAF_LOGS
      },
      log_delivery_parameters: {
        log_types: ["APPLICATION_LOGS"], # accepts APPLICATION_LOGS, USAGE_LOGS, SECURITY_FINDING_LOGS, ACCESS_LOGS, CONNECTION_LOGS, S3_SERVER_ACCESS_LOGS, ALB_ACCESS_LOGS, ALB_CONNECTION_LOGS, ALB_HEALTH_CHECK_LOGS
      },
      msk_monitoring_parameters: {
        enhanced_monitoring: "DEFAULT", # accepts DEFAULT, PER_BROKER, PER_TOPIC_PER_BROKER, PER_TOPIC_PER_PARTITION
      },
      kms_key_arn: "KmsKeyArn",
    },
    scope: "String",
    selection_criteria: "String",
    allow_field_updates: false,
    regions: ["Region"],
    all_regions: false,
  },
})

Response structure


resp.rule_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_identifier (required, String) —

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

  • :rule (required, Types::TelemetryRule) —

    The new configuration details for the organization telemetry rule, including resource type, telemetry type, and destination configuration.

Returns:

See Also:



2833
2834
2835
2836
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2833

def update_telemetry_rule_for_organization(params = {}, options = {})
  req = build_request(:update_telemetry_rule_for_organization, params)
  req.send_request(options)
end

#validate_telemetry_pipeline_configuration(params = {}) ⇒ Types::ValidateTelemetryPipelineConfigurationOutput

Validates a pipeline configuration without creating the pipeline. This operation checks the configuration for syntax errors and compatibility issues.

Examples:

Request syntax with placeholder values


resp = client.validate_telemetry_pipeline_configuration({
  configuration: { # required
    body: "TelemetryPipelineConfigurationBody", # required
  },
})

Response structure


resp.errors #=> Array
resp.errors[0].message #=> String
resp.errors[0].reason #=> String
resp.errors[0].field_map #=> Hash
resp.errors[0].field_map["String"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



2869
2870
2871
2872
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2869

def validate_telemetry_pipeline_configuration(params = {}, options = {})
  req = build_request(:validate_telemetry_pipeline_configuration, params)
  req.send_request(options)
end