Class: Aws::ObservabilityAdmin::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ObservabilityAdmin::Client
- 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
API Operations collapse
-
#create_centralization_rule_for_organization(params = {}) ⇒ Types::CreateCentralizationRuleForOrganizationOutput
Creates a centralization rule that applies across an Amazon Web Services Organization.
-
#create_connector(params = {}) ⇒ Types::CreateConnectorOutput
Creates a connector to a third-party cloud provider.
-
#create_dataset_integration(params = {}) ⇒ Types::CreateDatasetIntegrationOutput
Creates a dataset integration for the caller's account in the current region and returns its ARN.
-
#create_s3_table_integration(params = {}) ⇒ Types::CreateS3TableIntegrationOutput
Creates an integration between CloudWatch and S3 Tables for analytics.
-
#create_telemetry_pipeline(params = {}) ⇒ Types::CreateTelemetryPipelineOutput
Creates a telemetry pipeline for processing and transforming telemetry data.
-
#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.
-
#create_telemetry_rule_for_organization(params = {}) ⇒ Types::CreateTelemetryRuleForOrganizationOutput
Creates a telemetry rule that applies across an Amazon Web Services Organization.
-
#delete_centralization_rule_for_organization(params = {}) ⇒ Struct
Deletes an organization-wide centralization rule.
-
#delete_connector(params = {}) ⇒ Struct
Deletes a connector and its telemetry manifest.
-
#delete_dataset_integration(params = {}) ⇒ Struct
Deletes a dataset integration for the caller's account in the current region.
-
#delete_s3_table_integration(params = {}) ⇒ Struct
Deletes an S3 Table integration and its associated data.
-
#delete_telemetry_pipeline(params = {}) ⇒ Struct
Deletes a telemetry pipeline and its associated resources.
-
#delete_telemetry_rule(params = {}) ⇒ Struct
Deletes a telemetry rule from your account.
-
#delete_telemetry_rule_for_organization(params = {}) ⇒ Struct
Deletes an organization-wide telemetry rule.
-
#get_centralization_rule_for_organization(params = {}) ⇒ Types::GetCentralizationRuleForOrganizationOutput
Retrieves the details of a specific organization centralization rule.
-
#get_connector(params = {}) ⇒ Types::GetConnectorOutput
Retrieves the details of a connector.
-
#get_connector_telemetry_manifest(params = {}) ⇒ Types::GetConnectorTelemetryManifestOutput
Retrieves the telemetry manifest of a connector and its current version.
-
#get_connector_telemetry_setup(params = {}) ⇒ Types::GetConnectorTelemetrySetupOutput
Generates the artifacts that you use to create the infrastructure in your cloud provider that delivers the telemetry declared in the connector's telemetry manifest.
-
#get_dataset_integration(params = {}) ⇒ Types::GetDatasetIntegrationOutput
Returns the dataset integration for the caller's account in the current region.
-
#get_s3_table_integration(params = {}) ⇒ Types::GetS3TableIntegrationOutput
Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.
-
#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.
-
#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.
-
#get_telemetry_evaluation_status_for_organization(params = {}) ⇒ Types::GetTelemetryEvaluationStatusForOrganizationOutput
This returns the onboarding status of the telemetry configuration feature for the organization.
-
#get_telemetry_pipeline(params = {}) ⇒ Types::GetTelemetryPipelineOutput
Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.
-
#get_telemetry_rule(params = {}) ⇒ Types::GetTelemetryRuleOutput
Retrieves the details of a specific telemetry rule in your account.
-
#get_telemetry_rule_for_organization(params = {}) ⇒ Types::GetTelemetryRuleForOrganizationOutput
Retrieves the details of a specific organization telemetry rule.
-
#get_third_party_telemetry_enrichment(params = {}) ⇒ Types::GetThirdPartyTelemetryEnrichmentOutput
Returns the details of a third-party telemetry enrichment, including its status and source configuration.
-
#list_centralization_rules_for_organization(params = {}) ⇒ Types::ListCentralizationRulesForOrganizationOutput
Lists all centralization rules in your organization.
-
#list_connectors(params = {}) ⇒ Types::ListConnectorsOutput
Lists the connectors in the account and Region.
-
#list_dataset_integrations(params = {}) ⇒ Types::ListDatasetIntegrationsOutput
Returns the dataset integrations in your account.
-
#list_resource_telemetry(params = {}) ⇒ Types::ListResourceTelemetryOutput
Returns a list of telemetry configurations for Amazon Web Services resources supported by telemetry config.
-
#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.
-
#list_resources_by_connector(params = {}) ⇒ Types::ListResourcesByConnectorOutput
Lists resources in your cloud provider that the connector can access, such as management groups, subscriptions, resource types, Regions, resources, and Event Hubs.
-
#list_s3_table_integrations(params = {}) ⇒ Types::ListS3TableIntegrationsOutput
Lists all S3 Table integrations in your account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists all tags attached to the specified resource.
-
#list_telemetry_pipelines(params = {}) ⇒ Types::ListTelemetryPipelinesOutput
Returns a list of telemetry pipelines in your account.
-
#list_telemetry_rules(params = {}) ⇒ Types::ListTelemetryRulesOutput
Lists all telemetry rules in your account.
-
#list_telemetry_rules_for_organization(params = {}) ⇒ Types::ListTelemetryRulesForOrganizationOutput
Lists all telemetry rules in your organization.
-
#list_third_party_telemetry_enrichments(params = {}) ⇒ Types::ListThirdPartyTelemetryEnrichmentsOutput
Returns a summary of each third-party telemetry enrichment in your account and Region.
-
#put_connector_telemetry_manifest(params = {}) ⇒ Types::PutConnectorTelemetryManifestOutput
Creates or replaces the telemetry manifest of a connector.
-
#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.
-
#start_telemetry_evaluation(params = {}) ⇒ Struct
This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.
-
#start_telemetry_evaluation_for_organization(params = {}) ⇒ Struct
This actions begins onboarding the organization and all member accounts to the telemetry config feature.
-
#start_telemetry_pipeline_refresh(params = {}) ⇒ Struct
Starts a refresh of an external-cloud telemetry pipeline.
-
#start_third_party_telemetry_enrichment(params = {}) ⇒ Types::StartThirdPartyTelemetryEnrichmentOutput
Starts a third-party telemetry enrichment.
-
#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.
-
#stop_telemetry_evaluation(params = {}) ⇒ Struct
This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.
-
#stop_telemetry_evaluation_for_organization(params = {}) ⇒ Struct
This action offboards the Organization of the caller Amazon Web Services account from the telemetry config feature.
-
#stop_third_party_telemetry_enrichment(params = {}) ⇒ Types::StopThirdPartyTelemetryEnrichmentOutput
Stops a third-party telemetry enrichment.
-
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for a resource.
-
#test_telemetry_pipeline(params = {}) ⇒ Types::TestTelemetryPipelineOutput
Tests a pipeline configuration with sample records to validate data processing before deployment.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource.
-
#update_centralization_rule_for_organization(params = {}) ⇒ Types::UpdateCentralizationRuleForOrganizationOutput
Updates an existing centralization rule that applies across an Amazon Web Services Organization.
-
#update_dataset_integration(params = {}) ⇒ Types::UpdateDatasetIntegrationOutput
Updates a dataset integration for the caller's account in the current region.
-
#update_telemetry_pipeline(params = {}) ⇒ Struct
Updates the configuration of an existing telemetry pipeline.
-
#update_telemetry_rule(params = {}) ⇒ Types::UpdateTelemetryRuleOutput
Updates an existing telemetry rule in your account.
-
#update_telemetry_rule_for_organization(params = {}) ⇒ Types::UpdateTelemetryRuleForOrganizationOutput
Updates an existing telemetry rule that applies across an Amazon Web Services Organization.
-
#validate_telemetry_pipeline_configuration(params = {}) ⇒ Types::ValidateTelemetryPipelineConfigurationOutput
Validates a pipeline configuration without creating the pipeline.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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.
479 480 481 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 479 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.
577 578 579 580 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 577 def create_centralization_rule_for_organization(params = {}, = {}) req = build_request(:create_centralization_rule_for_organization, params) req.send_request() end |
#create_connector(params = {}) ⇒ Types::CreateConnectorOutput
Creates a connector to a third-party cloud provider. With a connector, you can discover resources in the provider and collect their telemetry. Currently, Microsoft Azure is the only supported provider.
653 654 655 656 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 653 def create_connector(params = {}, = {}) req = build_request(:create_connector, params) req.send_request() 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.
704 705 706 707 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 704 def create_dataset_integration(params = {}, = {}) req = build_request(:create_dataset_integration, params) req.send_request() 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.
751 752 753 754 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 751 def create_s3_table_integration(params = {}, = {}) req = build_request(:create_s3_table_integration, params) req.send_request() 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.
803 804 805 806 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 803 def create_telemetry_pipeline(params = {}, = {}) req = build_request(:create_telemetry_pipeline, params) req.send_request() 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.
928 929 930 931 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 928 def create_telemetry_rule(params = {}, = {}) req = build_request(:create_telemetry_rule, params) req.send_request() 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.
1052 1053 1054 1055 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1052 def create_telemetry_rule_for_organization(params = {}, = {}) req = build_request(:create_telemetry_rule_for_organization, params) req.send_request() 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.
1077 1078 1079 1080 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1077 def delete_centralization_rule_for_organization(params = {}, = {}) req = build_request(:delete_centralization_rule_for_organization, params) req.send_request() end |
#delete_connector(params = {}) ⇒ Struct
Deletes a connector and its telemetry manifest.
1103 1104 1105 1106 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1103 def delete_connector(params = {}, = {}) req = build_request(:delete_connector, params) req.send_request() 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.
1127 1128 1129 1130 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1127 def delete_dataset_integration(params = {}, = {}) req = build_request(:delete_dataset_integration, params) req.send_request() 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.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1151 def delete_s3_table_integration(params = {}, = {}) req = build_request(:delete_s3_table_integration, params) req.send_request() end |
#delete_telemetry_pipeline(params = {}) ⇒ Struct
Deletes a telemetry pipeline and its associated resources. This operation stops data processing and removes the pipeline configuration.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1175 def delete_telemetry_pipeline(params = {}, = {}) req = build_request(:delete_telemetry_pipeline, params) req.send_request() 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.
1199 1200 1201 1202 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1199 def delete_telemetry_rule(params = {}, = {}) req = build_request(:delete_telemetry_rule, params) req.send_request() 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.
1224 1225 1226 1227 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1224 def delete_telemetry_rule_for_organization(params = {}, = {}) req = build_request(:delete_telemetry_rule_for_organization, params) req.send_request() 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.
1298 1299 1300 1301 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1298 def get_centralization_rule_for_organization(params = {}, = {}) req = build_request(:get_centralization_rule_for_organization, params) req.send_request() end |
#get_connector(params = {}) ⇒ Types::GetConnectorOutput
Retrieves the details of a connector.
1336 1337 1338 1339 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1336 def get_connector(params = {}, = {}) req = build_request(:get_connector, params) req.send_request() end |
#get_connector_telemetry_manifest(params = {}) ⇒ Types::GetConnectorTelemetryManifestOutput
Retrieves the telemetry manifest of a connector and its current
version. If the connector has no telemetry manifest, this operation
returns a ResourceNotFoundException.
1399 1400 1401 1402 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1399 def get_connector_telemetry_manifest(params = {}, = {}) req = build_request(:get_connector_telemetry_manifest, params) req.send_request() end |
#get_connector_telemetry_setup(params = {}) ⇒ Types::GetConnectorTelemetrySetupOutput
Generates the artifacts that you use to create the infrastructure in your cloud provider that delivers the telemetry declared in the connector's telemetry manifest. This operation doesn't change any resources in your cloud provider or in Amazon Web Services.
1455 1456 1457 1458 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1455 def get_connector_telemetry_setup(params = {}, = {}) req = build_request(:get_connector_telemetry_setup, params) req.send_request() end |
#get_dataset_integration(params = {}) ⇒ Types::GetDatasetIntegrationOutput
Returns the dataset integration for the caller's account in the current region.
1490 1491 1492 1493 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1490 def get_dataset_integration(params = {}, = {}) req = build_request(:get_dataset_integration, params) req.send_request() end |
#get_s3_table_integration(params = {}) ⇒ Types::GetS3TableIntegrationOutput
Retrieves information about a specific S3 Table integration, including its configuration, status, and metadata.
1531 1532 1533 1534 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1531 def get_s3_table_integration(params = {}, = {}) req = build_request(:get_s3_table_integration, params) req.send_request() 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.
1554 1555 1556 1557 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1554 def get_telemetry_enrichment_status(params = {}, = {}) req = build_request(:get_telemetry_enrichment_status, params) req.send_request() 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.
1585 1586 1587 1588 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1585 def get_telemetry_evaluation_status(params = {}, = {}) req = build_request(:get_telemetry_evaluation_status, params) req.send_request() 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.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1617 def get_telemetry_evaluation_status_for_organization(params = {}, = {}) req = build_request(:get_telemetry_evaluation_status_for_organization, params) req.send_request() end |
#get_telemetry_pipeline(params = {}) ⇒ Types::GetTelemetryPipelineOutput
Retrieves information about a specific telemetry pipeline, including its configuration, status, and metadata.
1667 1668 1669 1670 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1667 def get_telemetry_pipeline(params = {}, = {}) req = build_request(:get_telemetry_pipeline, params) req.send_request() end |
#get_telemetry_rule(params = {}) ⇒ Types::GetTelemetryRuleOutput
Retrieves the details of a specific telemetry rule in your account.
1763 1764 1765 1766 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1763 def get_telemetry_rule(params = {}, = {}) req = build_request(:get_telemetry_rule, params) req.send_request() 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.
1862 1863 1864 1865 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1862 def get_telemetry_rule_for_organization(params = {}, = {}) req = build_request(:get_telemetry_rule_for_organization, params) req.send_request() end |
#get_third_party_telemetry_enrichment(params = {}) ⇒ Types::GetThirdPartyTelemetryEnrichmentOutput
Returns the details of a third-party telemetry enrichment, including its status and source configuration.
1908 1909 1910 1911 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1908 def get_third_party_telemetry_enrichment(params = {}, = {}) req = build_request(:get_third_party_telemetry_enrichment, params) req.send_request() 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.
1971 1972 1973 1974 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 1971 def list_centralization_rules_for_organization(params = {}, = {}) req = build_request(:list_centralization_rules_for_organization, params) req.send_request() end |
#list_connectors(params = {}) ⇒ Types::ListConnectorsOutput
Lists the connectors in the account and Region. This operation returns
results in pages. To get the next page, pass the returned NextToken
in the next call. We recommend that you use 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.
2015 2016 2017 2018 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2015 def list_connectors(params = {}, = {}) req = build_request(:list_connectors, params) req.send_request() 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.
2056 2057 2058 2059 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2056 def list_dataset_integrations(params = {}, = {}) req = build_request(:list_dataset_integrations, params) req.send_request() 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.
2153 2154 2155 2156 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2153 def list_resource_telemetry(params = {}, = {}) req = build_request(:list_resource_telemetry, params) req.send_request() 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.
2251 2252 2253 2254 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2251 def list_resource_telemetry_for_organization(params = {}, = {}) req = build_request(:list_resource_telemetry_for_organization, params) req.send_request() end |
#list_resources_by_connector(params = {}) ⇒ Types::ListResourcesByConnectorOutput
Lists resources in your cloud provider that the connector can access,
such as management groups, subscriptions, resource types, Regions,
resources, and Event Hubs. Use the results to build a telemetry
manifest. This operation returns results in pages. To get the next
page, pass the returned NextToken in the next call. We recommend
that you use pagination to ensure that the operation returns quickly
and successfully.
2374 2375 2376 2377 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2374 def list_resources_by_connector(params = {}, = {}) req = build_request(:list_resources_by_connector, params) req.send_request() 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.
2416 2417 2418 2419 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2416 def list_s3_table_integrations(params = {}, = {}) req = build_request(:list_s3_table_integrations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Lists all tags attached to the specified resource. Supports telemetry rule resources, telemetry pipeline resources, and third-party telemetry enrichment resources.
2448 2449 2450 2451 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2448 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() 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.
2505 2506 2507 2508 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2505 def list_telemetry_pipelines(params = {}, = {}) req = build_request(:list_telemetry_pipelines, params) req.send_request() 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.
2556 2557 2558 2559 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2556 def list_telemetry_rules(params = {}, = {}) req = build_request(:list_telemetry_rules, params) req.send_request() 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.
2619 2620 2621 2622 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2619 def list_telemetry_rules_for_organization(params = {}, = {}) req = build_request(:list_telemetry_rules_for_organization, params) req.send_request() end |
#list_third_party_telemetry_enrichments(params = {}) ⇒ Types::ListThirdPartyTelemetryEnrichmentsOutput
Returns a summary of each third-party telemetry enrichment in your
account and Region. To get the full configuration of an enrichment,
use GetThirdPartyTelemetryEnrichment. The results are paginated. To
get the next page of results, use NextToken.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2682 2683 2684 2685 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2682 def list_third_party_telemetry_enrichments(params = {}, = {}) req = build_request(:list_third_party_telemetry_enrichments, params) req.send_request() end |
#put_connector_telemetry_manifest(params = {}) ⇒ Types::PutConnectorTelemetryManifestOutput
Creates or replaces the telemetry manifest of a connector. The
telemetry manifest declares which resources in your cloud provider to
collect telemetry from and which telemetry types to collect. To avoid
overwriting changes made by another caller, specify ExpectedVersion.
2792 2793 2794 2795 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2792 def put_connector_telemetry_manifest(params = {}, = {}) req = build_request(:put_connector_telemetry_manifest, params) req.send_request() 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.
2816 2817 2818 2819 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2816 def start_telemetry_enrichment(params = {}, = {}) req = build_request(:start_telemetry_enrichment, params) req.send_request() end |
#start_telemetry_evaluation(params = {}) ⇒ Struct
This action begins onboarding the caller Amazon Web Services account to the telemetry config feature.
2854 2855 2856 2857 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2854 def start_telemetry_evaluation(params = {}, = {}) req = build_request(:start_telemetry_evaluation, params) req.send_request() end |
#start_telemetry_evaluation_for_organization(params = {}) ⇒ Struct
This actions begins onboarding the organization and all member accounts to the telemetry config feature.
2893 2894 2895 2896 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2893 def start_telemetry_evaluation_for_organization(params = {}, = {}) req = build_request(:start_telemetry_evaluation_for_organization, params) req.send_request() end |
#start_telemetry_pipeline_refresh(params = {}) ⇒ Struct
Starts a refresh of an external-cloud telemetry pipeline. The refresh re-reads the connector's telemetry manifest and re-discovers the sources in scope.
The pipeline must be in the ACTIVE or UPDATE_FAILED state, with no
refresh already running. You can use GetTelemetryPipeline to track
the refresh.
2921 2922 2923 2924 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2921 def start_telemetry_pipeline_refresh(params = {}, = {}) req = build_request(:start_telemetry_pipeline_refresh, params) req.send_request() end |
#start_third_party_telemetry_enrichment(params = {}) ⇒ Types::StartThirdPartyTelemetryEnrichmentOutput
Starts a third-party telemetry enrichment. An enrichment adds resource metadata, such as tags, from a third-party telemetry source to the telemetry that CloudWatch receives from the resources of that source.
You specify an Amazon Web Services Config connector for your third-party environment, such as a Microsoft Azure tenant. You can use each connector for only one enrichment.
To use this operation, you must have the
config:PutThirdPartyServiceLinkedConfigurationRecorder permission.
If the Amazon Web Services Config service-linked role does not exist
in your account, you must also have the iam:CreateServiceLinkedRole
permission.
2990 2991 2992 2993 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 2990 def start_third_party_telemetry_enrichment(params = {}, = {}) req = build_request(:start_third_party_telemetry_enrichment, params) req.send_request() 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.
3011 3012 3013 3014 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3011 def stop_telemetry_enrichment(params = {}, = {}) req = build_request(:stop_telemetry_enrichment, params) req.send_request() end |
#stop_telemetry_evaluation(params = {}) ⇒ Struct
This action begins offboarding the caller Amazon Web Services account from the telemetry config feature.
3025 3026 3027 3028 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3025 def stop_telemetry_evaluation(params = {}, = {}) req = build_request(:stop_telemetry_evaluation, params) req.send_request() 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.
3039 3040 3041 3042 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3039 def stop_telemetry_evaluation_for_organization(params = {}, = {}) req = build_request(:stop_telemetry_evaluation_for_organization, params) req.send_request() end |
#stop_third_party_telemetry_enrichment(params = {}) ⇒ Types::StopThirdPartyTelemetryEnrichmentOutput
Stops a third-party telemetry enrichment. CloudWatch stops adding resource metadata from the third-party telemetry source to your telemetry.
To use this operation, you must have the
config:DeleteServiceLinkedConfigurationRecorder permission.
3083 3084 3085 3086 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3083 def stop_third_party_telemetry_enrichment(params = {}, = {}) req = build_request(:stop_third_party_telemetry_enrichment, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds or updates tags for a resource. Supports telemetry rule resources, telemetry pipeline resources, and third-party telemetry enrichment resources.
3113 3114 3115 3116 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3113 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() 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.
3163 3164 3165 3166 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3163 def test_telemetry_pipeline(params = {}, = {}) req = build_request(:test_telemetry_pipeline, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a resource. Supports telemetry rule resources, telemetry pipeline resources, and third-party telemetry enrichment resources.
3192 3193 3194 3195 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3192 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() 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.
3282 3283 3284 3285 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3282 def update_centralization_rule_for_organization(params = {}, = {}) req = build_request(:update_centralization_rule_for_organization, params) req.send_request() 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.
3323 3324 3325 3326 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3323 def update_dataset_integration(params = {}, = {}) req = build_request(:update_dataset_integration, params) req.send_request() end |
#update_telemetry_pipeline(params = {}) ⇒ Struct
Updates the configuration of an existing telemetry pipeline.
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_arnFixed:
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 groupFixed:
notification_type,aws.region- GitHub Audit Logs
Updatable: All Amazon Web Services Secrets Manager attributes,
scope(can switch between ORGANIZATION/ENTERPRISE),organizationorenterprisename,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)
3421 3422 3423 3424 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3421 def update_telemetry_pipeline(params = {}, = {}) req = build_request(:update_telemetry_pipeline, params) req.send_request() 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.
3536 3537 3538 3539 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3536 def update_telemetry_rule(params = {}, = {}) req = build_request(:update_telemetry_rule, params) req.send_request() 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.
3654 3655 3656 3657 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3654 def update_telemetry_rule_for_organization(params = {}, = {}) req = build_request(:update_telemetry_rule_for_organization, params) req.send_request() 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.
3690 3691 3692 3693 |
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/client.rb', line 3690 def validate_telemetry_pipeline_configuration(params = {}, = {}) req = build_request(:validate_telemetry_pipeline_configuration, params) req.send_request() end |