Module Awso_observabilityadmin_syncSource

Sourceval delete_centralization_rule_for_organization : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_observabilityadmin.Values.DeleteCentralizationRuleForOrganizationInput.t -> (unit, unit) Result.t
Sourceval delete_s3_table_integration : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_observabilityadmin.Values.DeleteS3TableIntegrationInput.t -> (unit, unit) Result.t
Sourceval delete_telemetry_rule : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_observabilityadmin.Values.DeleteTelemetryRuleInput.t -> (unit, unit) Result.t
Sourceval delete_telemetry_rule_for_organization : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_observabilityadmin.Values.DeleteTelemetryRuleForOrganizationInput.t -> (unit, unit) Result.t
Sourceval start_telemetry_evaluation : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_observabilityadmin.Values.StartTelemetryEvaluationInput.t -> (unit, unit) Result.t
Sourceval start_telemetry_evaluation_for_organization : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_observabilityadmin.Values.StartTelemetryEvaluationForOrganizationInput.t -> (unit, unit) Result.t
Sourceval stop_telemetry_evaluation : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> unit -> (unit, unit) Result.t
Sourceval stop_telemetry_evaluation_for_organization : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> unit -> (unit, unit) Result.t
Sourceval tag_resource : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_observabilityadmin.Values.TagResourceInput.t -> (unit, unit) Result.t
Sourceval untag_resource : ?endpoint_url:string -> ?cfg:Awso.Cfg.t -> Awso_observabilityadmin.Values.UntagResourceInput.t -> (unit, unit) Result.t
include module type of struct include Awso_observabilityadmin.Values end
Sourceval service : Awso.Service.t
Sourceval apiVersion : string
Sourceval endpointPrefix : string
Sourceval serviceFullName : string
Sourceval signatureVersion : string
Sourceval protocol : string
Sourceval globalEndpoint : string
Sourceval simple_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval composed_to_json : ('a -> Awso__Botodata.value) -> 'a -> Yojson.Safe.t
Sourceval to_query : ('a -> Awso.Client.Query.value) -> 'a -> Awso.Client.Query.t
Sourceval structure_to_value_aux : ('a * 'b option) list -> f:(('a * 'b) list -> 'c) -> [> `Structure of 'c ]
Sourceval structure_to_value : ('a * 'b option) list -> [> `Structure of ('a * 'b) list ]
Sourceval structure_to_wrapped_value : wrapper:'a -> response:'a -> ('b * 'c option) list -> [> `Structure of ('a * [> `Structure of ('b * 'c) list ]) list ]

Condition that matches based on the specific WAF action taken on the request.

Condition that matches based on WAF rule labels, with label names limited to 1024 characters.

A single condition that can match based on WAF rule action or label name.

Defines criteria for selecting resources based on field values.

A single filter condition that specifies behavior, requirement, and matching conditions for WAF log records.

Structure containing a name field limited to 64 characters for header or query parameter identification.

Advanced event selectors let you create fine-grained selectors for management, data, and network activity events.

Specifies a field in the request to redact from WAF logs, such as headers, query parameters, or body content.

The pattern used to generate destination log group names during centralization. The pattern can contain static text and dynamic variables that are replaced with source attributes. If a variable cannot be resolved, it inherits the value from its parent variable in the hierarchy. The pattern must be between 1 and 512 characters. Supported variables: ${source.logGroup} — The original log group name from the source account. ${source.accountId} — The Amazon Web Services account ID where the log originated. ${source.region} — The Amazon Web Services Region where the log originated. ${source.org.id} — The Amazon Web Services Organization ID of the source account. ${source.org.ouId} — The organizational unit ID of the source account. ${source.org.rootId} — The organization Root ID. ${source.org.path} — The organizational path from account to root.

Information about a data source associated with the telemetry pipeline. For CloudWatch Logs sources, this includes both a name and type extracted from the log event metadata. For third-party sources (such as S3), this includes only a name, with the type field left empty.

A list of source plugin types used in the pipeline configuration (such as cloudwatch_logs or s3). Currently supports a single source per pipeline, but is structured as a list to accommodate multiple pipelines in the configuration.

Configuration that determines which WAF log records to keep or drop based on specified conditions.

Configuration that specifies a naming pattern for destination log groups created during centralization. The pattern supports static text and dynamic variables that are replaced with source attributes when log groups are created.

Configuration for backing up centralized log data to a secondary region.

Configuration for encrypting centralized log groups. This configuration is only applied to destination log groups for which the corresponding source log groups are encrypted using Customer Managed KMS Keys.

Represents a detailed validation error with message, reason, and field mapping for comprehensive error reporting.

Parameters specific to Amazon Web Services CloudTrail telemetry configuration.

Configuration parameters for ELB load balancer logging, including output format and field delimiter settings.

Configuration parameters for Amazon Bedrock AgentCore logging, including logType settings.

Configuration parameters for Amazon MSK cluster monitoring, including enhanced monitoring level settings.

Configuration parameters specific to VPC Flow Logs.

Configuration parameters for WAF logging, including redacted fields and logging filters.

Configuration for centralization destination log groups, including encryption and backup settings.

Configuration for selecting and handling source log groups for centralization.

Contains detailed error information from pipeline test operations, providing structured error responses for better debugging and troubleshooting capabilities.

Represents a test record structure used for pipeline testing operations to validate data processing.

Provides a summary of pipeline configuration components including sources, processors, and destinations.

Configuration specifying where and how telemetry data should be delivered for Amazon Web Services resources.

Configuration specifying the primary destination for centralized telemetry data.

Configuration specifying the source of telemetry data to be centralized.

Contains the output from pipeline test operations, including processed records and any errors encountered.

A summary of a telemetry rule's key properties.

Contains summary information about a telemetry pipeline for listing operations.

Contains summary information about an S3 Table integration for listing operations.

A model representing the state of a resource within an account according to telemetry config.

A summary of a centralization rule's key properties and status.

Represents the status of a multi-region operation in a specific Amazon Web Services Region. This structure is used to report per-region progress for both telemetry evaluation and telemetry rule replication.

Defines the configuration for a pipeline, including how data flows from sources through processors to destinations. The configuration is specified in YAML format and must include a valid pipeline definition with required source and sink components. This pipeline enables end-to-end telemetry data collection, transformation, and delivery while supporting optional processing steps and extensions for enhanced functionality. The primary pipeline configuration section are: Source: Defines where log data originates from (S3 buckets, CloudWatch Logs, third-party APIs). Each pipeline must have exactly one source. Processors (optional): Transform, parse, and enrich log data as it flows through the pipeline. Processors are applied sequentially in the order they are defined. Sink: Defines the destination where processed log data is sent. Each pipeline must have exactly one sink. Extensions (optional): Provide additional functionality such as Amazon Web Services Secrets Manager integration for credential management. For more details on each configuration section see CloudWatch pipelines User Guide. Additional comprehensive configuration examples can be found in the CreateTelemetryPipeline API docs.

Provides detailed information about the status of a telemetry pipeline, including reasons for specific states.

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for Amazon Web Services resources in the IAM user guide.

Indicates the request has failed to process because of an unknown server error, exception, or failure.

The request throughput limit was exceeded.

Indicates input validation failed. Check your request parameters and retry the request.

The requested operation conflicts with the current state of the specified resource or with another request.

The specified resource (such as a telemetry rule) could not be found.

The requested operation would exceed the allowed quota for the specified resource type.

Defines how telemetry should be configured for specific Amazon Web Services resources.

Defines how telemetry data should be centralized across an Amazon Web Services Organization, including source and destination configurations.

Sourcemodule ListResourceTelemetryForOrganizationMaxResults = Awso_observabilityadmin.Values.ListResourceTelemetryForOrganizationMaxResults
Sourcemodule ListCentralizationRulesForOrganizationInputRuleNamePrefixString = Awso_observabilityadmin.Values.ListCentralizationRulesForOrganizationInputRuleNamePrefixString
Sourcemodule ListCentralizationRulesForOrganizationMaxResults = Awso_observabilityadmin.Values.ListCentralizationRulesForOrganizationMaxResults

Represents a complete telemetry pipeline resource with configuration, status, and metadata for data processing and transformation.

Defines the encryption configuration for S3 Table integrations, including the encryption algorithm and KMS key settings.

Sourcemodule ValidateTelemetryPipelineConfigurationOutput = Awso_observabilityadmin.Values.ValidateTelemetryPipelineConfigurationOutput

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

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

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.

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.

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.

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.

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)

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)

Sourcemodule UpdateCentralizationRuleForOrganizationOutput = Awso_observabilityadmin.Values.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.

Sourcemodule UpdateCentralizationRuleForOrganizationInput = Awso_observabilityadmin.Values.UpdateCentralizationRuleForOrganizationInput

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.

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

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

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

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

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

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

Sourcemodule StartTelemetryEvaluationForOrganizationInput = Awso_observabilityadmin.Values.StartTelemetryEvaluationForOrganizationInput

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

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.

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

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

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

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

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.

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.

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

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

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

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

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

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

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

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

Sourcemodule ListCentralizationRulesForOrganizationOutput = Awso_observabilityadmin.Values.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.

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 requested operation cannot be completed on the specified resource in the current state.

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

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

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.

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.

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

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

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.

Sourcemodule GetTelemetryEvaluationStatusForOrganizationOutput = Awso_observabilityadmin.Values.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.

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

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

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

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.

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.

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.

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

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

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

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

Sourcemodule DeleteCentralizationRuleForOrganizationInput = Awso_observabilityadmin.Values.DeleteCentralizationRuleForOrganizationInput

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

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.

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.

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.

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.

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.

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.

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.

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.

Sourcemodule CreateCentralizationRuleForOrganizationOutput = Awso_observabilityadmin.Values.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.

Sourcemodule CreateCentralizationRuleForOrganizationInput = Awso_observabilityadmin.Values.CreateCentralizationRuleForOrganizationInput

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.