aws-sdk-observabilityadmin 1.12.0 → 1.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '096ae59a9f3f8d98c3300b1314d1c21398cc4ea2dc4ddeac6962c320531f8996'
4
- data.tar.gz: 7a73d4d5caf4b756af369f8c127e5f8fbca023049da42165d6229482ed6a3f2f
3
+ metadata.gz: 895998530a51f8afe1cf5d89f3f754a5f601019273d9816386f0c9eea1640cce
4
+ data.tar.gz: '084f94ea9ff1f4ddeee71bcc1cba23faeb1344a406b0d132155cbb96fb216f03'
5
5
  SHA512:
6
- metadata.gz: add0fc93039b629cd2894146dfcd13b6769251006952871a99df359f579564ea7f633039b9620af54d658de16fe1daebd533af89372c3ce91571e44aed56c612
7
- data.tar.gz: c5f324899ca3bb6f1890a796b56c59557b895b2ae07cd75f3fdb0d8aed36d6c219f57977fcb68bfb82dade89643bbc98cd16ba204771ffa70dda11fe0220c109
6
+ metadata.gz: 2484a8532cbf3e741702729ad32d6102914a10c75e9d34ff331be67d5e3e9864bf28f40a9b4e30cb0bac023bbfdfab6eeced9a8bd45aa84c5e9ee979d2d22f7a
7
+ data.tar.gz: 5be8fd05106d302537fba223a6cf39315339b8b65b74617d6d8dec8aef1573acfab936bed92722499b79b73820251d788245566c269625ee3407a031e94cab9d
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.14.0 (2025-10-13)
5
+ ------------------
6
+
7
+ * Feature - CloudWatch Observability Admin adds the ability to enable Resource tags for telemetry in a customer account. The release introduces new APIs to enable, disable and describe the status of Resource tags for telemetry feature. This new capability simplifies monitoring AWS resources using tags.
8
+
9
+ 1.13.0 (2025-09-15)
10
+ ------------------
11
+
12
+ * Feature - CloudWatch Observability Admin adds the ability to enable telemetry centralization in customers' Organizations. The release introduces new APIs to manage centralization rules, which define settings to replicate telemetry data to a central destination in the customers' Organization.
13
+
4
14
  1.12.0 (2025-08-26)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.12.0
1
+ 1.14.0
@@ -476,6 +476,75 @@ module Aws::ObservabilityAdmin
476
476
 
477
477
  # @!group API Operations
478
478
 
479
+ # Creates a centralization rule that applies across an Amazon Web
480
+ # Services Organization. This operation can only be called by the
481
+ # organization's management account or a delegated administrator
482
+ # account.
483
+ #
484
+ # @option params [required, String] :rule_name
485
+ # A unique name for the organization-wide centralization rule being
486
+ # created.
487
+ #
488
+ # @option params [required, Types::CentralizationRule] :rule
489
+ # The configuration details for the organization-wide centralization
490
+ # rule, including the source configuration and the destination
491
+ # configuration to centralize telemetry data across the organization.
492
+ #
493
+ # @option params [Hash<String,String>] :tags
494
+ # The key-value pairs to associate with the organization telemetry rule
495
+ # resource for categorization and management purposes.
496
+ #
497
+ # @return [Types::CreateCentralizationRuleForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
498
+ #
499
+ # * {Types::CreateCentralizationRuleForOrganizationOutput#rule_arn #rule_arn} => String
500
+ #
501
+ # @example Request syntax with placeholder values
502
+ #
503
+ # resp = client.create_centralization_rule_for_organization({
504
+ # rule_name: "RuleName", # required
505
+ # rule: { # required
506
+ # source: { # required
507
+ # regions: ["Region"], # required
508
+ # scope: "SourceFilterString",
509
+ # source_logs_configuration: {
510
+ # log_group_selection_criteria: "LogsFilterString", # required
511
+ # encrypted_log_group_strategy: "ALLOW", # required, accepts ALLOW, SKIP
512
+ # },
513
+ # },
514
+ # destination: { # required
515
+ # region: "Region", # required
516
+ # account: "AccountIdentifier",
517
+ # destination_logs_configuration: {
518
+ # logs_encryption_configuration: {
519
+ # encryption_strategy: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, AWS_OWNED
520
+ # kms_key_arn: "ResourceArn",
521
+ # encryption_conflict_resolution_strategy: "ALLOW", # accepts ALLOW, SKIP
522
+ # },
523
+ # backup_configuration: {
524
+ # region: "Region", # required
525
+ # kms_key_arn: "ResourceArn",
526
+ # },
527
+ # },
528
+ # },
529
+ # },
530
+ # tags: {
531
+ # "TagKey" => "TagValue",
532
+ # },
533
+ # })
534
+ #
535
+ # @example Response structure
536
+ #
537
+ # resp.rule_arn #=> String
538
+ #
539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CreateCentralizationRuleForOrganization AWS API Documentation
540
+ #
541
+ # @overload create_centralization_rule_for_organization(params = {})
542
+ # @param [Hash] params ({})
543
+ def create_centralization_rule_for_organization(params = {}, options = {})
544
+ req = build_request(:create_centralization_rule_for_organization, params)
545
+ req.send_request(options)
546
+ end
547
+
479
548
  # Creates a telemetry rule that defines how telemetry should be
480
549
  # configured for Amazon Web Services resources in your account. The rule
481
550
  # specifies which resources should have telemetry enabled and how that
@@ -595,6 +664,31 @@ module Aws::ObservabilityAdmin
595
664
  req.send_request(options)
596
665
  end
597
666
 
667
+ # Deletes an organization-wide centralization rule. This operation can
668
+ # only be called by the organization's management account or a
669
+ # delegated administrator account.
670
+ #
671
+ # @option params [required, String] :rule_identifier
672
+ # The identifier (name or ARN) of the organization centralization rule
673
+ # to delete.
674
+ #
675
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
676
+ #
677
+ # @example Request syntax with placeholder values
678
+ #
679
+ # resp = client.delete_centralization_rule_for_organization({
680
+ # rule_identifier: "RuleIdentifier", # required
681
+ # })
682
+ #
683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/DeleteCentralizationRuleForOrganization AWS API Documentation
684
+ #
685
+ # @overload delete_centralization_rule_for_organization(params = {})
686
+ # @param [Hash] params ({})
687
+ def delete_centralization_rule_for_organization(params = {}, options = {})
688
+ req = build_request(:delete_centralization_rule_for_organization, params)
689
+ req.send_request(options)
690
+ end
691
+
598
692
  # Deletes a telemetry rule from your account. Any telemetry
599
693
  # configurations previously created by the rule will remain but no new
600
694
  # resources will be configured by this rule.
@@ -644,6 +738,87 @@ module Aws::ObservabilityAdmin
644
738
  req.send_request(options)
645
739
  end
646
740
 
741
+ # Retrieves the details of a specific organization centralization rule.
742
+ # This operation can only be called by the organization's management
743
+ # account or a delegated administrator account.
744
+ #
745
+ # @option params [required, String] :rule_identifier
746
+ # The identifier (name or ARN) of the organization centralization rule
747
+ # to retrieve.
748
+ #
749
+ # @return [Types::GetCentralizationRuleForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
750
+ #
751
+ # * {Types::GetCentralizationRuleForOrganizationOutput#rule_name #rule_name} => String
752
+ # * {Types::GetCentralizationRuleForOrganizationOutput#rule_arn #rule_arn} => String
753
+ # * {Types::GetCentralizationRuleForOrganizationOutput#creator_account_id #creator_account_id} => String
754
+ # * {Types::GetCentralizationRuleForOrganizationOutput#created_time_stamp #created_time_stamp} => Integer
755
+ # * {Types::GetCentralizationRuleForOrganizationOutput#created_region #created_region} => String
756
+ # * {Types::GetCentralizationRuleForOrganizationOutput#last_update_time_stamp #last_update_time_stamp} => Integer
757
+ # * {Types::GetCentralizationRuleForOrganizationOutput#rule_health #rule_health} => String
758
+ # * {Types::GetCentralizationRuleForOrganizationOutput#failure_reason #failure_reason} => String
759
+ # * {Types::GetCentralizationRuleForOrganizationOutput#centralization_rule #centralization_rule} => Types::CentralizationRule
760
+ #
761
+ # @example Request syntax with placeholder values
762
+ #
763
+ # resp = client.get_centralization_rule_for_organization({
764
+ # rule_identifier: "RuleIdentifier", # required
765
+ # })
766
+ #
767
+ # @example Response structure
768
+ #
769
+ # resp.rule_name #=> String
770
+ # resp.rule_arn #=> String
771
+ # resp.creator_account_id #=> String
772
+ # resp.created_time_stamp #=> Integer
773
+ # resp.created_region #=> String
774
+ # resp.last_update_time_stamp #=> Integer
775
+ # resp.rule_health #=> String, one of "Healthy", "Unhealthy", "Provisioning"
776
+ # resp.failure_reason #=> String, one of "TRUSTED_ACCESS_NOT_ENABLED", "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION", "INTERNAL_SERVER_ERROR"
777
+ # resp.centralization_rule.source.regions #=> Array
778
+ # resp.centralization_rule.source.regions[0] #=> String
779
+ # resp.centralization_rule.source.scope #=> String
780
+ # resp.centralization_rule.source.source_logs_configuration.log_group_selection_criteria #=> String
781
+ # resp.centralization_rule.source.source_logs_configuration.encrypted_log_group_strategy #=> String, one of "ALLOW", "SKIP"
782
+ # resp.centralization_rule.destination.region #=> String
783
+ # resp.centralization_rule.destination.account #=> String
784
+ # resp.centralization_rule.destination.destination_logs_configuration.logs_encryption_configuration.encryption_strategy #=> String, one of "CUSTOMER_MANAGED", "AWS_OWNED"
785
+ # resp.centralization_rule.destination.destination_logs_configuration.logs_encryption_configuration.kms_key_arn #=> String
786
+ # resp.centralization_rule.destination.destination_logs_configuration.logs_encryption_configuration.encryption_conflict_resolution_strategy #=> String, one of "ALLOW", "SKIP"
787
+ # resp.centralization_rule.destination.destination_logs_configuration.backup_configuration.region #=> String
788
+ # resp.centralization_rule.destination.destination_logs_configuration.backup_configuration.kms_key_arn #=> String
789
+ #
790
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetCentralizationRuleForOrganization AWS API Documentation
791
+ #
792
+ # @overload get_centralization_rule_for_organization(params = {})
793
+ # @param [Hash] params ({})
794
+ def get_centralization_rule_for_organization(params = {}, options = {})
795
+ req = build_request(:get_centralization_rule_for_organization, params)
796
+ req.send_request(options)
797
+ end
798
+
799
+ # Returns the current status of the resource tags for telemetry feature,
800
+ # which enhances telemetry data with additional resource metadata from
801
+ # Amazon Web Services Resource Explorer.
802
+ #
803
+ # @return [Types::GetTelemetryEnrichmentStatusOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
804
+ #
805
+ # * {Types::GetTelemetryEnrichmentStatusOutput#status #status} => String
806
+ # * {Types::GetTelemetryEnrichmentStatusOutput#aws_resource_explorer_managed_view_arn #aws_resource_explorer_managed_view_arn} => String
807
+ #
808
+ # @example Response structure
809
+ #
810
+ # resp.status #=> String, one of "Running", "Stopped", "Impaired"
811
+ # resp.aws_resource_explorer_managed_view_arn #=> String
812
+ #
813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetTelemetryEnrichmentStatus AWS API Documentation
814
+ #
815
+ # @overload get_telemetry_enrichment_status(params = {})
816
+ # @param [Hash] params ({})
817
+ def get_telemetry_enrichment_status(params = {}, options = {})
818
+ req = build_request(:get_telemetry_enrichment_status, params)
819
+ req.send_request(options)
820
+ end
821
+
647
822
  # Returns the current onboarding status of the telemetry config feature,
648
823
  # including the status of the feature and reason the feature failed to
649
824
  # start or stop.
@@ -784,6 +959,66 @@ module Aws::ObservabilityAdmin
784
959
  req.send_request(options)
785
960
  end
786
961
 
962
+ # Lists all centralization rules in your organization. This operation
963
+ # can only be called by the organization's management account or a
964
+ # delegated administrator account.
965
+ #
966
+ # @option params [String] :rule_name_prefix
967
+ # A string to filter organization centralization rules whose names begin
968
+ # with the specified prefix.
969
+ #
970
+ # @option params [Boolean] :all_regions
971
+ # A flag determining whether to return organization centralization rules
972
+ # from all regions or only the current region.
973
+ #
974
+ # @option params [Integer] :max_results
975
+ # The maximum number of organization centralization rules to return in a
976
+ # single call.
977
+ #
978
+ # @option params [String] :next_token
979
+ # The token for the next set of results. A previous call generates this
980
+ # token.
981
+ #
982
+ # @return [Types::ListCentralizationRulesForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
983
+ #
984
+ # * {Types::ListCentralizationRulesForOrganizationOutput#centralization_rule_summaries #centralization_rule_summaries} => Array&lt;Types::CentralizationRuleSummary&gt;
985
+ # * {Types::ListCentralizationRulesForOrganizationOutput#next_token #next_token} => String
986
+ #
987
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
988
+ #
989
+ # @example Request syntax with placeholder values
990
+ #
991
+ # resp = client.list_centralization_rules_for_organization({
992
+ # rule_name_prefix: "ListCentralizationRulesForOrganizationInputRuleNamePrefixString",
993
+ # all_regions: false,
994
+ # max_results: 1,
995
+ # next_token: "NextToken",
996
+ # })
997
+ #
998
+ # @example Response structure
999
+ #
1000
+ # resp.centralization_rule_summaries #=> Array
1001
+ # resp.centralization_rule_summaries[0].rule_name #=> String
1002
+ # resp.centralization_rule_summaries[0].rule_arn #=> String
1003
+ # resp.centralization_rule_summaries[0].creator_account_id #=> String
1004
+ # resp.centralization_rule_summaries[0].created_time_stamp #=> Integer
1005
+ # resp.centralization_rule_summaries[0].created_region #=> String
1006
+ # resp.centralization_rule_summaries[0].last_update_time_stamp #=> Integer
1007
+ # resp.centralization_rule_summaries[0].rule_health #=> String, one of "Healthy", "Unhealthy", "Provisioning"
1008
+ # resp.centralization_rule_summaries[0].failure_reason #=> String, one of "TRUSTED_ACCESS_NOT_ENABLED", "DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION", "INTERNAL_SERVER_ERROR"
1009
+ # resp.centralization_rule_summaries[0].destination_account_id #=> String
1010
+ # resp.centralization_rule_summaries[0].destination_region #=> String
1011
+ # resp.next_token #=> String
1012
+ #
1013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListCentralizationRulesForOrganization AWS API Documentation
1014
+ #
1015
+ # @overload list_centralization_rules_for_organization(params = {})
1016
+ # @param [Hash] params ({})
1017
+ def list_centralization_rules_for_organization(params = {}, options = {})
1018
+ req = build_request(:list_centralization_rules_for_organization, params)
1019
+ req.send_request(options)
1020
+ end
1021
+
787
1022
  # Returns a list of telemetry configurations for Amazon Web Services
788
1023
  # resources supported by telemetry config. For more information, see
789
1024
  # [Auditing CloudWatch telemetry configurations][1].
@@ -1089,6 +1324,30 @@ module Aws::ObservabilityAdmin
1089
1324
  req.send_request(options)
1090
1325
  end
1091
1326
 
1327
+ # Enables the resource tags for telemetry feature for your account,
1328
+ # which enhances telemetry data with additional resource metadata from
1329
+ # Amazon Web Services Resource Explorer to provide richer context for
1330
+ # monitoring and observability.
1331
+ #
1332
+ # @return [Types::StartTelemetryEnrichmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1333
+ #
1334
+ # * {Types::StartTelemetryEnrichmentOutput#status #status} => String
1335
+ # * {Types::StartTelemetryEnrichmentOutput#aws_resource_explorer_managed_view_arn #aws_resource_explorer_managed_view_arn} => String
1336
+ #
1337
+ # @example Response structure
1338
+ #
1339
+ # resp.status #=> String, one of "Running", "Stopped", "Impaired"
1340
+ # resp.aws_resource_explorer_managed_view_arn #=> String
1341
+ #
1342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/StartTelemetryEnrichment AWS API Documentation
1343
+ #
1344
+ # @overload start_telemetry_enrichment(params = {})
1345
+ # @param [Hash] params ({})
1346
+ def start_telemetry_enrichment(params = {}, options = {})
1347
+ req = build_request(:start_telemetry_enrichment, params)
1348
+ req.send_request(options)
1349
+ end
1350
+
1092
1351
  # This action begins onboarding the caller Amazon Web Services account
1093
1352
  # to the telemetry config feature.
1094
1353
  #
@@ -1117,6 +1376,27 @@ module Aws::ObservabilityAdmin
1117
1376
  req.send_request(options)
1118
1377
  end
1119
1378
 
1379
+ # Disables the resource tags for telemetry feature for your account,
1380
+ # stopping the enhancement of telemetry data with additional resource
1381
+ # metadata.
1382
+ #
1383
+ # @return [Types::StopTelemetryEnrichmentOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1384
+ #
1385
+ # * {Types::StopTelemetryEnrichmentOutput#status #status} => String
1386
+ #
1387
+ # @example Response structure
1388
+ #
1389
+ # resp.status #=> String, one of "Running", "Stopped", "Impaired"
1390
+ #
1391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/StopTelemetryEnrichment AWS API Documentation
1392
+ #
1393
+ # @overload stop_telemetry_enrichment(params = {})
1394
+ # @param [Hash] params ({})
1395
+ def stop_telemetry_enrichment(params = {}, options = {})
1396
+ req = build_request(:stop_telemetry_enrichment, params)
1397
+ req.send_request(options)
1398
+ end
1399
+
1120
1400
  # This action begins offboarding the caller Amazon Web Services account
1121
1401
  # from the telemetry config feature.
1122
1402
  #
@@ -1200,6 +1480,68 @@ module Aws::ObservabilityAdmin
1200
1480
  req.send_request(options)
1201
1481
  end
1202
1482
 
1483
+ # Updates an existing centralization rule that applies across an Amazon
1484
+ # Web Services Organization. This operation can only be called by the
1485
+ # organization's management account or a delegated administrator
1486
+ # account.
1487
+ #
1488
+ # @option params [required, String] :rule_identifier
1489
+ # The identifier (name or ARN) of the organization centralization rule
1490
+ # to update.
1491
+ #
1492
+ # @option params [required, Types::CentralizationRule] :rule
1493
+ # The configuration details for the organization-wide centralization
1494
+ # rule, including the source configuration and the destination
1495
+ # configuration to centralize telemetry data across the organization.
1496
+ #
1497
+ # @return [Types::UpdateCentralizationRuleForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1498
+ #
1499
+ # * {Types::UpdateCentralizationRuleForOrganizationOutput#rule_arn #rule_arn} => String
1500
+ #
1501
+ # @example Request syntax with placeholder values
1502
+ #
1503
+ # resp = client.update_centralization_rule_for_organization({
1504
+ # rule_identifier: "RuleIdentifier", # required
1505
+ # rule: { # required
1506
+ # source: { # required
1507
+ # regions: ["Region"], # required
1508
+ # scope: "SourceFilterString",
1509
+ # source_logs_configuration: {
1510
+ # log_group_selection_criteria: "LogsFilterString", # required
1511
+ # encrypted_log_group_strategy: "ALLOW", # required, accepts ALLOW, SKIP
1512
+ # },
1513
+ # },
1514
+ # destination: { # required
1515
+ # region: "Region", # required
1516
+ # account: "AccountIdentifier",
1517
+ # destination_logs_configuration: {
1518
+ # logs_encryption_configuration: {
1519
+ # encryption_strategy: "CUSTOMER_MANAGED", # required, accepts CUSTOMER_MANAGED, AWS_OWNED
1520
+ # kms_key_arn: "ResourceArn",
1521
+ # encryption_conflict_resolution_strategy: "ALLOW", # accepts ALLOW, SKIP
1522
+ # },
1523
+ # backup_configuration: {
1524
+ # region: "Region", # required
1525
+ # kms_key_arn: "ResourceArn",
1526
+ # },
1527
+ # },
1528
+ # },
1529
+ # },
1530
+ # })
1531
+ #
1532
+ # @example Response structure
1533
+ #
1534
+ # resp.rule_arn #=> String
1535
+ #
1536
+ # @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/UpdateCentralizationRuleForOrganization AWS API Documentation
1537
+ #
1538
+ # @overload update_centralization_rule_for_organization(params = {})
1539
+ # @param [Hash] params ({})
1540
+ def update_centralization_rule_for_organization(params = {}, options = {})
1541
+ req = build_request(:update_centralization_rule_for_organization, params)
1542
+ req.send_request(options)
1543
+ end
1544
+
1203
1545
  # Updates an existing telemetry rule in your account.
1204
1546
  #
1205
1547
  # @option params [required, String] :rule_identifier
@@ -1318,7 +1660,7 @@ module Aws::ObservabilityAdmin
1318
1660
  tracer: tracer
1319
1661
  )
1320
1662
  context[:gem_name] = 'aws-sdk-observabilityadmin'
1321
- context[:gem_version] = '1.12.0'
1663
+ context[:gem_version] = '1.14.0'
1322
1664
  Seahorse::Client::Request.new(handlers, context)
1323
1665
  end
1324
1666