aws-sdk-observabilityadmin 1.8.0 → 1.9.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 +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-observabilityadmin/client.rb +572 -16
- data/lib/aws-sdk-observabilityadmin/client_api.rb +369 -0
- data/lib/aws-sdk-observabilityadmin/errors.rb +69 -0
- data/lib/aws-sdk-observabilityadmin/types.rb +616 -9
- data/lib/aws-sdk-observabilityadmin.rb +2 -2
- data/sig/client.rbs +198 -0
- data/sig/errors.rbs +13 -0
- data/sig/types.rbs +189 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2ba75d9156f64f7df00142afddb752cdeeb05b97a68572a6e6f7fc1ae7d97bc9
|
4
|
+
data.tar.gz: 38f9e3c8dbfaa4a5ecb7061c406e37847d4cf2101719dbcbaef4ecf0dc56d086
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3e8b5b67e1f857a0e219c7f65c4acb1f8b1d22ff5e7eabb2face62fb4fb6bcde5ba05a5836dd28cc63b3d81cf946e0762be994fbb43ddf62feb0a867ab664602
|
7
|
+
data.tar.gz: a66f5190f2caeab5f9a67596506587c9a0d656e544b932716cff6d6d46481917f41549129ec1ae6bfadc3443b3e59cfb8a99449131861725d1ee849ff0d8365d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.9.0 (2025-08-01)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - CloudWatch Observability Admin adds the ability to enable telemetry on AWS resources such as Amazon VPCs (Flow Logs) in customers AWS Accounts and Organizations. The release introduces new APIs to manage telemetry rules, which define telemetry settings to be applied on AWS resources.
|
8
|
+
|
4
9
|
1.8.0 (2025-07-31)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.9.0
|
@@ -479,6 +479,174 @@ module Aws::ObservabilityAdmin
|
|
479
479
|
|
480
480
|
# @!group API Operations
|
481
481
|
|
482
|
+
# Creates a telemetry rule that defines how telemetry should be
|
483
|
+
# configured for Amazon Web Services resources in your account. The rule
|
484
|
+
# specifies which resources should have telemetry enabled and how that
|
485
|
+
# telemetry data should be collected based on resource type, telemetry
|
486
|
+
# type, and selection criteria.
|
487
|
+
#
|
488
|
+
# @option params [required, String] :rule_name
|
489
|
+
# A unique name for the telemetry rule being created.
|
490
|
+
#
|
491
|
+
# @option params [required, Types::TelemetryRule] :rule
|
492
|
+
# The configuration details for the telemetry rule, including the
|
493
|
+
# resource type, telemetry type, destination configuration, and
|
494
|
+
# selection criteria for which resources the rule applies to.
|
495
|
+
#
|
496
|
+
# @option params [Hash<String,String>] :tags
|
497
|
+
# The key-value pairs to associate with the telemetry rule resource for
|
498
|
+
# categorization and management purposes.
|
499
|
+
#
|
500
|
+
# @return [Types::CreateTelemetryRuleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
501
|
+
#
|
502
|
+
# * {Types::CreateTelemetryRuleOutput#rule_arn #rule_arn} => String
|
503
|
+
#
|
504
|
+
# @example Request syntax with placeholder values
|
505
|
+
#
|
506
|
+
# resp = client.create_telemetry_rule({
|
507
|
+
# rule_name: "RuleName", # required
|
508
|
+
# rule: { # required
|
509
|
+
# resource_type: "AWS::EC2::Instance", # accepts AWS::EC2::Instance, AWS::EC2::VPC, AWS::Lambda::Function
|
510
|
+
# telemetry_type: "Logs", # required, accepts Logs, Metrics, Traces
|
511
|
+
# destination_configuration: {
|
512
|
+
# destination_type: "cloud-watch-logs", # accepts cloud-watch-logs
|
513
|
+
# destination_pattern: "String",
|
514
|
+
# retention_in_days: 1,
|
515
|
+
# vpc_flow_log_parameters: {
|
516
|
+
# log_format: "String",
|
517
|
+
# traffic_type: "String",
|
518
|
+
# max_aggregation_interval: 1,
|
519
|
+
# },
|
520
|
+
# },
|
521
|
+
# scope: "String",
|
522
|
+
# selection_criteria: "String",
|
523
|
+
# },
|
524
|
+
# tags: {
|
525
|
+
# "TagKey" => "TagValue",
|
526
|
+
# },
|
527
|
+
# })
|
528
|
+
#
|
529
|
+
# @example Response structure
|
530
|
+
#
|
531
|
+
# resp.rule_arn #=> String
|
532
|
+
#
|
533
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CreateTelemetryRule AWS API Documentation
|
534
|
+
#
|
535
|
+
# @overload create_telemetry_rule(params = {})
|
536
|
+
# @param [Hash] params ({})
|
537
|
+
def create_telemetry_rule(params = {}, options = {})
|
538
|
+
req = build_request(:create_telemetry_rule, params)
|
539
|
+
req.send_request(options)
|
540
|
+
end
|
541
|
+
|
542
|
+
# Creates a telemetry rule that applies across an Amazon Web Services
|
543
|
+
# Organization. This operation can only be called by the organization's
|
544
|
+
# management account or a delegated administrator account.
|
545
|
+
#
|
546
|
+
# @option params [required, String] :rule_name
|
547
|
+
# A unique name for the organization-wide telemetry rule being created.
|
548
|
+
#
|
549
|
+
# @option params [required, Types::TelemetryRule] :rule
|
550
|
+
# The configuration details for the organization-wide telemetry rule,
|
551
|
+
# including the resource type, telemetry type, destination
|
552
|
+
# configuration, and selection criteria for which resources the rule
|
553
|
+
# applies to across the organization.
|
554
|
+
#
|
555
|
+
# @option params [Hash<String,String>] :tags
|
556
|
+
# The key-value pairs to associate with the organization telemetry rule
|
557
|
+
# resource for categorization and management purposes.
|
558
|
+
#
|
559
|
+
# @return [Types::CreateTelemetryRuleForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
560
|
+
#
|
561
|
+
# * {Types::CreateTelemetryRuleForOrganizationOutput#rule_arn #rule_arn} => String
|
562
|
+
#
|
563
|
+
# @example Request syntax with placeholder values
|
564
|
+
#
|
565
|
+
# resp = client.create_telemetry_rule_for_organization({
|
566
|
+
# rule_name: "RuleName", # required
|
567
|
+
# rule: { # required
|
568
|
+
# resource_type: "AWS::EC2::Instance", # accepts AWS::EC2::Instance, AWS::EC2::VPC, AWS::Lambda::Function
|
569
|
+
# telemetry_type: "Logs", # required, accepts Logs, Metrics, Traces
|
570
|
+
# destination_configuration: {
|
571
|
+
# destination_type: "cloud-watch-logs", # accepts cloud-watch-logs
|
572
|
+
# destination_pattern: "String",
|
573
|
+
# retention_in_days: 1,
|
574
|
+
# vpc_flow_log_parameters: {
|
575
|
+
# log_format: "String",
|
576
|
+
# traffic_type: "String",
|
577
|
+
# max_aggregation_interval: 1,
|
578
|
+
# },
|
579
|
+
# },
|
580
|
+
# scope: "String",
|
581
|
+
# selection_criteria: "String",
|
582
|
+
# },
|
583
|
+
# tags: {
|
584
|
+
# "TagKey" => "TagValue",
|
585
|
+
# },
|
586
|
+
# })
|
587
|
+
#
|
588
|
+
# @example Response structure
|
589
|
+
#
|
590
|
+
# resp.rule_arn #=> String
|
591
|
+
#
|
592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/CreateTelemetryRuleForOrganization AWS API Documentation
|
593
|
+
#
|
594
|
+
# @overload create_telemetry_rule_for_organization(params = {})
|
595
|
+
# @param [Hash] params ({})
|
596
|
+
def create_telemetry_rule_for_organization(params = {}, options = {})
|
597
|
+
req = build_request(:create_telemetry_rule_for_organization, params)
|
598
|
+
req.send_request(options)
|
599
|
+
end
|
600
|
+
|
601
|
+
# Deletes a telemetry rule from your account. Any telemetry
|
602
|
+
# configurations previously created by the rule will remain but no new
|
603
|
+
# resources will be configured by this rule.
|
604
|
+
#
|
605
|
+
# @option params [required, String] :rule_identifier
|
606
|
+
# The identifier (name or ARN) of the telemetry rule to delete.
|
607
|
+
#
|
608
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
609
|
+
#
|
610
|
+
# @example Request syntax with placeholder values
|
611
|
+
#
|
612
|
+
# resp = client.delete_telemetry_rule({
|
613
|
+
# rule_identifier: "RuleIdentifier", # required
|
614
|
+
# })
|
615
|
+
#
|
616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/DeleteTelemetryRule AWS API Documentation
|
617
|
+
#
|
618
|
+
# @overload delete_telemetry_rule(params = {})
|
619
|
+
# @param [Hash] params ({})
|
620
|
+
def delete_telemetry_rule(params = {}, options = {})
|
621
|
+
req = build_request(:delete_telemetry_rule, params)
|
622
|
+
req.send_request(options)
|
623
|
+
end
|
624
|
+
|
625
|
+
# Deletes an organization-wide telemetry rule. This operation can only
|
626
|
+
# be called by the organization's management account or a delegated
|
627
|
+
# administrator account.
|
628
|
+
#
|
629
|
+
# @option params [required, String] :rule_identifier
|
630
|
+
# The identifier (name or ARN) of the organization telemetry rule to
|
631
|
+
# delete.
|
632
|
+
#
|
633
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
634
|
+
#
|
635
|
+
# @example Request syntax with placeholder values
|
636
|
+
#
|
637
|
+
# resp = client.delete_telemetry_rule_for_organization({
|
638
|
+
# rule_identifier: "RuleIdentifier", # required
|
639
|
+
# })
|
640
|
+
#
|
641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/DeleteTelemetryRuleForOrganization AWS API Documentation
|
642
|
+
#
|
643
|
+
# @overload delete_telemetry_rule_for_organization(params = {})
|
644
|
+
# @param [Hash] params ({})
|
645
|
+
def delete_telemetry_rule_for_organization(params = {}, options = {})
|
646
|
+
req = build_request(:delete_telemetry_rule_for_organization, params)
|
647
|
+
req.send_request(options)
|
648
|
+
end
|
649
|
+
|
482
650
|
# Returns the current onboarding status of the telemetry config feature,
|
483
651
|
# including the status of the feature and reason the feature failed to
|
484
652
|
# start or stop.
|
@@ -504,8 +672,8 @@ module Aws::ObservabilityAdmin
|
|
504
672
|
|
505
673
|
# This returns the onboarding status of the telemetry configuration
|
506
674
|
# feature for the organization. It can only be called by a Management
|
507
|
-
# Account of an
|
508
|
-
# of
|
675
|
+
# Account of an Amazon Web Services Organization or an assigned
|
676
|
+
# Delegated Admin Account of Amazon CloudWatch telemetry config.
|
509
677
|
#
|
510
678
|
# @return [Types::GetTelemetryEvaluationStatusForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
511
679
|
#
|
@@ -526,9 +694,102 @@ module Aws::ObservabilityAdmin
|
|
526
694
|
req.send_request(options)
|
527
695
|
end
|
528
696
|
|
529
|
-
#
|
530
|
-
#
|
531
|
-
#
|
697
|
+
# Retrieves the details of a specific telemetry rule in your account.
|
698
|
+
#
|
699
|
+
# @option params [required, String] :rule_identifier
|
700
|
+
# The identifier (name or ARN) of the telemetry rule to retrieve.
|
701
|
+
#
|
702
|
+
# @return [Types::GetTelemetryRuleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
703
|
+
#
|
704
|
+
# * {Types::GetTelemetryRuleOutput#rule_name #rule_name} => String
|
705
|
+
# * {Types::GetTelemetryRuleOutput#rule_arn #rule_arn} => String
|
706
|
+
# * {Types::GetTelemetryRuleOutput#created_time_stamp #created_time_stamp} => Integer
|
707
|
+
# * {Types::GetTelemetryRuleOutput#last_update_time_stamp #last_update_time_stamp} => Integer
|
708
|
+
# * {Types::GetTelemetryRuleOutput#telemetry_rule #telemetry_rule} => Types::TelemetryRule
|
709
|
+
#
|
710
|
+
# @example Request syntax with placeholder values
|
711
|
+
#
|
712
|
+
# resp = client.get_telemetry_rule({
|
713
|
+
# rule_identifier: "RuleIdentifier", # required
|
714
|
+
# })
|
715
|
+
#
|
716
|
+
# @example Response structure
|
717
|
+
#
|
718
|
+
# resp.rule_name #=> String
|
719
|
+
# resp.rule_arn #=> String
|
720
|
+
# resp.created_time_stamp #=> Integer
|
721
|
+
# resp.last_update_time_stamp #=> Integer
|
722
|
+
# resp.telemetry_rule.resource_type #=> String, one of "AWS::EC2::Instance", "AWS::EC2::VPC", "AWS::Lambda::Function"
|
723
|
+
# resp.telemetry_rule.telemetry_type #=> String, one of "Logs", "Metrics", "Traces"
|
724
|
+
# resp.telemetry_rule.destination_configuration.destination_type #=> String, one of "cloud-watch-logs"
|
725
|
+
# resp.telemetry_rule.destination_configuration.destination_pattern #=> String
|
726
|
+
# resp.telemetry_rule.destination_configuration.retention_in_days #=> Integer
|
727
|
+
# resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.log_format #=> String
|
728
|
+
# resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.traffic_type #=> String
|
729
|
+
# resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.max_aggregation_interval #=> Integer
|
730
|
+
# resp.telemetry_rule.scope #=> String
|
731
|
+
# resp.telemetry_rule.selection_criteria #=> String
|
732
|
+
#
|
733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetTelemetryRule AWS API Documentation
|
734
|
+
#
|
735
|
+
# @overload get_telemetry_rule(params = {})
|
736
|
+
# @param [Hash] params ({})
|
737
|
+
def get_telemetry_rule(params = {}, options = {})
|
738
|
+
req = build_request(:get_telemetry_rule, params)
|
739
|
+
req.send_request(options)
|
740
|
+
end
|
741
|
+
|
742
|
+
# Retrieves the details of a specific organization telemetry rule. This
|
743
|
+
# operation can only be called by the organization's management account
|
744
|
+
# or a delegated administrator account.
|
745
|
+
#
|
746
|
+
# @option params [required, String] :rule_identifier
|
747
|
+
# The identifier (name or ARN) of the organization telemetry rule to
|
748
|
+
# retrieve.
|
749
|
+
#
|
750
|
+
# @return [Types::GetTelemetryRuleForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
751
|
+
#
|
752
|
+
# * {Types::GetTelemetryRuleForOrganizationOutput#rule_name #rule_name} => String
|
753
|
+
# * {Types::GetTelemetryRuleForOrganizationOutput#rule_arn #rule_arn} => String
|
754
|
+
# * {Types::GetTelemetryRuleForOrganizationOutput#created_time_stamp #created_time_stamp} => Integer
|
755
|
+
# * {Types::GetTelemetryRuleForOrganizationOutput#last_update_time_stamp #last_update_time_stamp} => Integer
|
756
|
+
# * {Types::GetTelemetryRuleForOrganizationOutput#telemetry_rule #telemetry_rule} => Types::TelemetryRule
|
757
|
+
#
|
758
|
+
# @example Request syntax with placeholder values
|
759
|
+
#
|
760
|
+
# resp = client.get_telemetry_rule_for_organization({
|
761
|
+
# rule_identifier: "RuleIdentifier", # required
|
762
|
+
# })
|
763
|
+
#
|
764
|
+
# @example Response structure
|
765
|
+
#
|
766
|
+
# resp.rule_name #=> String
|
767
|
+
# resp.rule_arn #=> String
|
768
|
+
# resp.created_time_stamp #=> Integer
|
769
|
+
# resp.last_update_time_stamp #=> Integer
|
770
|
+
# resp.telemetry_rule.resource_type #=> String, one of "AWS::EC2::Instance", "AWS::EC2::VPC", "AWS::Lambda::Function"
|
771
|
+
# resp.telemetry_rule.telemetry_type #=> String, one of "Logs", "Metrics", "Traces"
|
772
|
+
# resp.telemetry_rule.destination_configuration.destination_type #=> String, one of "cloud-watch-logs"
|
773
|
+
# resp.telemetry_rule.destination_configuration.destination_pattern #=> String
|
774
|
+
# resp.telemetry_rule.destination_configuration.retention_in_days #=> Integer
|
775
|
+
# resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.log_format #=> String
|
776
|
+
# resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.traffic_type #=> String
|
777
|
+
# resp.telemetry_rule.destination_configuration.vpc_flow_log_parameters.max_aggregation_interval #=> Integer
|
778
|
+
# resp.telemetry_rule.scope #=> String
|
779
|
+
# resp.telemetry_rule.selection_criteria #=> String
|
780
|
+
#
|
781
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/GetTelemetryRuleForOrganization AWS API Documentation
|
782
|
+
#
|
783
|
+
# @overload get_telemetry_rule_for_organization(params = {})
|
784
|
+
# @param [Hash] params ({})
|
785
|
+
def get_telemetry_rule_for_organization(params = {}, options = {})
|
786
|
+
req = build_request(:get_telemetry_rule_for_organization, params)
|
787
|
+
req.send_request(options)
|
788
|
+
end
|
789
|
+
|
790
|
+
# Returns a list of telemetry configurations for Amazon Web Services
|
791
|
+
# resources supported by telemetry config. For more information, see
|
792
|
+
# [Auditing CloudWatch telemetry configurations][1].
|
532
793
|
#
|
533
794
|
#
|
534
795
|
#
|
@@ -608,12 +869,12 @@ module Aws::ObservabilityAdmin
|
|
608
869
|
req.send_request(options)
|
609
870
|
end
|
610
871
|
|
611
|
-
# Returns a list of telemetry configurations for
|
612
|
-
# by telemetry config in the organization.
|
872
|
+
# Returns a list of telemetry configurations for Amazon Web Services
|
873
|
+
# resources supported by telemetry config in the organization.
|
613
874
|
#
|
614
875
|
# @option params [Array<String>] :account_identifiers
|
615
|
-
# A list of
|
616
|
-
# associated with the specified accounts.
|
876
|
+
# A list of Amazon Web Services accounts used to filter the resources to
|
877
|
+
# those associated with the specified accounts.
|
617
878
|
#
|
618
879
|
# @option params [String] :resource_identifier_prefix
|
619
880
|
# A string used to filter resources in the organization which have a
|
@@ -691,8 +952,148 @@ module Aws::ObservabilityAdmin
|
|
691
952
|
req.send_request(options)
|
692
953
|
end
|
693
954
|
|
694
|
-
#
|
695
|
-
#
|
955
|
+
# Lists all tags attached to the specified telemetry rule resource.
|
956
|
+
#
|
957
|
+
# @option params [required, String] :resource_arn
|
958
|
+
# The Amazon Resource Name (ARN) of the telemetry rule resource whose
|
959
|
+
# tags you want to list.
|
960
|
+
#
|
961
|
+
# @return [Types::ListTagsForResourceOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
962
|
+
#
|
963
|
+
# * {Types::ListTagsForResourceOutput#tags #tags} => Hash<String,String>
|
964
|
+
#
|
965
|
+
# @example Request syntax with placeholder values
|
966
|
+
#
|
967
|
+
# resp = client.list_tags_for_resource({
|
968
|
+
# resource_arn: "ResourceArn", # required
|
969
|
+
# })
|
970
|
+
#
|
971
|
+
# @example Response structure
|
972
|
+
#
|
973
|
+
# resp.tags #=> Hash
|
974
|
+
# resp.tags["String"] #=> String
|
975
|
+
#
|
976
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListTagsForResource AWS API Documentation
|
977
|
+
#
|
978
|
+
# @overload list_tags_for_resource(params = {})
|
979
|
+
# @param [Hash] params ({})
|
980
|
+
def list_tags_for_resource(params = {}, options = {})
|
981
|
+
req = build_request(:list_tags_for_resource, params)
|
982
|
+
req.send_request(options)
|
983
|
+
end
|
984
|
+
|
985
|
+
# Lists all telemetry rules in your account. You can filter the results
|
986
|
+
# by specifying a rule name prefix.
|
987
|
+
#
|
988
|
+
# @option params [String] :rule_name_prefix
|
989
|
+
# A string to filter telemetry rules whose names begin with the
|
990
|
+
# specified prefix.
|
991
|
+
#
|
992
|
+
# @option params [Integer] :max_results
|
993
|
+
# The maximum number of telemetry rules to return in a single call.
|
994
|
+
#
|
995
|
+
# @option params [String] :next_token
|
996
|
+
# The token for the next set of results. A previous call generates this
|
997
|
+
# token.
|
998
|
+
#
|
999
|
+
# @return [Types::ListTelemetryRulesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1000
|
+
#
|
1001
|
+
# * {Types::ListTelemetryRulesOutput#telemetry_rule_summaries #telemetry_rule_summaries} => Array<Types::TelemetryRuleSummary>
|
1002
|
+
# * {Types::ListTelemetryRulesOutput#next_token #next_token} => String
|
1003
|
+
#
|
1004
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1005
|
+
#
|
1006
|
+
# @example Request syntax with placeholder values
|
1007
|
+
#
|
1008
|
+
# resp = client.list_telemetry_rules({
|
1009
|
+
# rule_name_prefix: "String",
|
1010
|
+
# max_results: 1,
|
1011
|
+
# next_token: "NextToken",
|
1012
|
+
# })
|
1013
|
+
#
|
1014
|
+
# @example Response structure
|
1015
|
+
#
|
1016
|
+
# resp.telemetry_rule_summaries #=> Array
|
1017
|
+
# resp.telemetry_rule_summaries[0].rule_name #=> String
|
1018
|
+
# resp.telemetry_rule_summaries[0].rule_arn #=> String
|
1019
|
+
# resp.telemetry_rule_summaries[0].created_time_stamp #=> Integer
|
1020
|
+
# resp.telemetry_rule_summaries[0].last_update_time_stamp #=> Integer
|
1021
|
+
# resp.telemetry_rule_summaries[0].resource_type #=> String, one of "AWS::EC2::Instance", "AWS::EC2::VPC", "AWS::Lambda::Function"
|
1022
|
+
# resp.telemetry_rule_summaries[0].telemetry_type #=> String, one of "Logs", "Metrics", "Traces"
|
1023
|
+
# resp.next_token #=> String
|
1024
|
+
#
|
1025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListTelemetryRules AWS API Documentation
|
1026
|
+
#
|
1027
|
+
# @overload list_telemetry_rules(params = {})
|
1028
|
+
# @param [Hash] params ({})
|
1029
|
+
def list_telemetry_rules(params = {}, options = {})
|
1030
|
+
req = build_request(:list_telemetry_rules, params)
|
1031
|
+
req.send_request(options)
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
# Lists all telemetry rules in your organization. This operation can
|
1035
|
+
# only be called by the organization's management account or a
|
1036
|
+
# delegated administrator account.
|
1037
|
+
#
|
1038
|
+
# @option params [String] :rule_name_prefix
|
1039
|
+
# A string to filter organization telemetry rules whose names begin with
|
1040
|
+
# the specified prefix.
|
1041
|
+
#
|
1042
|
+
# @option params [Array<String>] :source_account_ids
|
1043
|
+
# The list of account IDs to filter organization telemetry rules by
|
1044
|
+
# their source accounts.
|
1045
|
+
#
|
1046
|
+
# @option params [Array<String>] :source_organization_unit_ids
|
1047
|
+
# The list of organizational unit IDs to filter organization telemetry
|
1048
|
+
# rules by their source organizational units.
|
1049
|
+
#
|
1050
|
+
# @option params [Integer] :max_results
|
1051
|
+
# The maximum number of organization telemetry rules to return in a
|
1052
|
+
# single call.
|
1053
|
+
#
|
1054
|
+
# @option params [String] :next_token
|
1055
|
+
# The token for the next set of results. A previous call generates this
|
1056
|
+
# token.
|
1057
|
+
#
|
1058
|
+
# @return [Types::ListTelemetryRulesForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1059
|
+
#
|
1060
|
+
# * {Types::ListTelemetryRulesForOrganizationOutput#telemetry_rule_summaries #telemetry_rule_summaries} => Array<Types::TelemetryRuleSummary>
|
1061
|
+
# * {Types::ListTelemetryRulesForOrganizationOutput#next_token #next_token} => String
|
1062
|
+
#
|
1063
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1064
|
+
#
|
1065
|
+
# @example Request syntax with placeholder values
|
1066
|
+
#
|
1067
|
+
# resp = client.list_telemetry_rules_for_organization({
|
1068
|
+
# rule_name_prefix: "String",
|
1069
|
+
# source_account_ids: ["AccountIdentifier"],
|
1070
|
+
# source_organization_unit_ids: ["OrganizationUnitIdentifier"],
|
1071
|
+
# max_results: 1,
|
1072
|
+
# next_token: "NextToken",
|
1073
|
+
# })
|
1074
|
+
#
|
1075
|
+
# @example Response structure
|
1076
|
+
#
|
1077
|
+
# resp.telemetry_rule_summaries #=> Array
|
1078
|
+
# resp.telemetry_rule_summaries[0].rule_name #=> String
|
1079
|
+
# resp.telemetry_rule_summaries[0].rule_arn #=> String
|
1080
|
+
# resp.telemetry_rule_summaries[0].created_time_stamp #=> Integer
|
1081
|
+
# resp.telemetry_rule_summaries[0].last_update_time_stamp #=> Integer
|
1082
|
+
# resp.telemetry_rule_summaries[0].resource_type #=> String, one of "AWS::EC2::Instance", "AWS::EC2::VPC", "AWS::Lambda::Function"
|
1083
|
+
# resp.telemetry_rule_summaries[0].telemetry_type #=> String, one of "Logs", "Metrics", "Traces"
|
1084
|
+
# resp.next_token #=> String
|
1085
|
+
#
|
1086
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/ListTelemetryRulesForOrganization AWS API Documentation
|
1087
|
+
#
|
1088
|
+
# @overload list_telemetry_rules_for_organization(params = {})
|
1089
|
+
# @param [Hash] params ({})
|
1090
|
+
def list_telemetry_rules_for_organization(params = {}, options = {})
|
1091
|
+
req = build_request(:list_telemetry_rules_for_organization, params)
|
1092
|
+
req.send_request(options)
|
1093
|
+
end
|
1094
|
+
|
1095
|
+
# This action begins onboarding the caller Amazon Web Services account
|
1096
|
+
# to the telemetry config feature.
|
696
1097
|
#
|
697
1098
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
698
1099
|
#
|
@@ -719,8 +1120,8 @@ module Aws::ObservabilityAdmin
|
|
719
1120
|
req.send_request(options)
|
720
1121
|
end
|
721
1122
|
|
722
|
-
# This action begins offboarding the caller
|
723
|
-
# telemetry config feature.
|
1123
|
+
# This action begins offboarding the caller Amazon Web Services account
|
1124
|
+
# from the telemetry config feature.
|
724
1125
|
#
|
725
1126
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
726
1127
|
#
|
@@ -733,8 +1134,8 @@ module Aws::ObservabilityAdmin
|
|
733
1134
|
req.send_request(options)
|
734
1135
|
end
|
735
1136
|
|
736
|
-
# This action offboards the Organization of the caller
|
737
|
-
#
|
1137
|
+
# This action offboards the Organization of the caller Amazon Web
|
1138
|
+
# Services account from the telemetry config feature.
|
738
1139
|
#
|
739
1140
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
740
1141
|
#
|
@@ -747,6 +1148,161 @@ module Aws::ObservabilityAdmin
|
|
747
1148
|
req.send_request(options)
|
748
1149
|
end
|
749
1150
|
|
1151
|
+
# Adds or updates tags for a telemetry rule resource.
|
1152
|
+
#
|
1153
|
+
# @option params [required, String] :resource_arn
|
1154
|
+
# The Amazon Resource Name (ARN) of the telemetry rule resource to tag.
|
1155
|
+
#
|
1156
|
+
# @option params [required, Hash<String,String>] :tags
|
1157
|
+
# The key-value pairs to add or update for the telemetry rule resource.
|
1158
|
+
#
|
1159
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1160
|
+
#
|
1161
|
+
# @example Request syntax with placeholder values
|
1162
|
+
#
|
1163
|
+
# resp = client.tag_resource({
|
1164
|
+
# resource_arn: "ResourceArn", # required
|
1165
|
+
# tags: { # required
|
1166
|
+
# "TagKey" => "TagValue",
|
1167
|
+
# },
|
1168
|
+
# })
|
1169
|
+
#
|
1170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/TagResource AWS API Documentation
|
1171
|
+
#
|
1172
|
+
# @overload tag_resource(params = {})
|
1173
|
+
# @param [Hash] params ({})
|
1174
|
+
def tag_resource(params = {}, options = {})
|
1175
|
+
req = build_request(:tag_resource, params)
|
1176
|
+
req.send_request(options)
|
1177
|
+
end
|
1178
|
+
|
1179
|
+
# Removes tags from a telemetry rule resource.
|
1180
|
+
#
|
1181
|
+
# @option params [required, String] :resource_arn
|
1182
|
+
# The Amazon Resource Name (ARN) of the telemetry rule resource to
|
1183
|
+
# remove tags from.
|
1184
|
+
#
|
1185
|
+
# @option params [required, Array<String>] :tag_keys
|
1186
|
+
# The list of tag keys to remove from the telemetry rule resource.
|
1187
|
+
#
|
1188
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1189
|
+
#
|
1190
|
+
# @example Request syntax with placeholder values
|
1191
|
+
#
|
1192
|
+
# resp = client.untag_resource({
|
1193
|
+
# resource_arn: "ResourceArn", # required
|
1194
|
+
# tag_keys: ["TagKey"], # required
|
1195
|
+
# })
|
1196
|
+
#
|
1197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/UntagResource AWS API Documentation
|
1198
|
+
#
|
1199
|
+
# @overload untag_resource(params = {})
|
1200
|
+
# @param [Hash] params ({})
|
1201
|
+
def untag_resource(params = {}, options = {})
|
1202
|
+
req = build_request(:untag_resource, params)
|
1203
|
+
req.send_request(options)
|
1204
|
+
end
|
1205
|
+
|
1206
|
+
# Updates an existing telemetry rule in your account.
|
1207
|
+
#
|
1208
|
+
# @option params [required, String] :rule_identifier
|
1209
|
+
# The identifier (name or ARN) of the telemetry rule to update.
|
1210
|
+
#
|
1211
|
+
# @option params [required, Types::TelemetryRule] :rule
|
1212
|
+
# The new configuration details for the telemetry rule.
|
1213
|
+
#
|
1214
|
+
# @return [Types::UpdateTelemetryRuleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1215
|
+
#
|
1216
|
+
# * {Types::UpdateTelemetryRuleOutput#rule_arn #rule_arn} => String
|
1217
|
+
#
|
1218
|
+
# @example Request syntax with placeholder values
|
1219
|
+
#
|
1220
|
+
# resp = client.update_telemetry_rule({
|
1221
|
+
# rule_identifier: "RuleIdentifier", # required
|
1222
|
+
# rule: { # required
|
1223
|
+
# resource_type: "AWS::EC2::Instance", # accepts AWS::EC2::Instance, AWS::EC2::VPC, AWS::Lambda::Function
|
1224
|
+
# telemetry_type: "Logs", # required, accepts Logs, Metrics, Traces
|
1225
|
+
# destination_configuration: {
|
1226
|
+
# destination_type: "cloud-watch-logs", # accepts cloud-watch-logs
|
1227
|
+
# destination_pattern: "String",
|
1228
|
+
# retention_in_days: 1,
|
1229
|
+
# vpc_flow_log_parameters: {
|
1230
|
+
# log_format: "String",
|
1231
|
+
# traffic_type: "String",
|
1232
|
+
# max_aggregation_interval: 1,
|
1233
|
+
# },
|
1234
|
+
# },
|
1235
|
+
# scope: "String",
|
1236
|
+
# selection_criteria: "String",
|
1237
|
+
# },
|
1238
|
+
# })
|
1239
|
+
#
|
1240
|
+
# @example Response structure
|
1241
|
+
#
|
1242
|
+
# resp.rule_arn #=> String
|
1243
|
+
#
|
1244
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/UpdateTelemetryRule AWS API Documentation
|
1245
|
+
#
|
1246
|
+
# @overload update_telemetry_rule(params = {})
|
1247
|
+
# @param [Hash] params ({})
|
1248
|
+
def update_telemetry_rule(params = {}, options = {})
|
1249
|
+
req = build_request(:update_telemetry_rule, params)
|
1250
|
+
req.send_request(options)
|
1251
|
+
end
|
1252
|
+
|
1253
|
+
# Updates an existing telemetry rule that applies across an Amazon Web
|
1254
|
+
# Services Organization. This operation can only be called by the
|
1255
|
+
# organization's management account or a delegated administrator
|
1256
|
+
# account.
|
1257
|
+
#
|
1258
|
+
# @option params [required, String] :rule_identifier
|
1259
|
+
# The identifier (name or ARN) of the organization telemetry rule to
|
1260
|
+
# update.
|
1261
|
+
#
|
1262
|
+
# @option params [required, Types::TelemetryRule] :rule
|
1263
|
+
# The new configuration details for the organization telemetry rule,
|
1264
|
+
# including resource type, telemetry type, and destination
|
1265
|
+
# configuration.
|
1266
|
+
#
|
1267
|
+
# @return [Types::UpdateTelemetryRuleForOrganizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1268
|
+
#
|
1269
|
+
# * {Types::UpdateTelemetryRuleForOrganizationOutput#rule_arn #rule_arn} => String
|
1270
|
+
#
|
1271
|
+
# @example Request syntax with placeholder values
|
1272
|
+
#
|
1273
|
+
# resp = client.update_telemetry_rule_for_organization({
|
1274
|
+
# rule_identifier: "RuleIdentifier", # required
|
1275
|
+
# rule: { # required
|
1276
|
+
# resource_type: "AWS::EC2::Instance", # accepts AWS::EC2::Instance, AWS::EC2::VPC, AWS::Lambda::Function
|
1277
|
+
# telemetry_type: "Logs", # required, accepts Logs, Metrics, Traces
|
1278
|
+
# destination_configuration: {
|
1279
|
+
# destination_type: "cloud-watch-logs", # accepts cloud-watch-logs
|
1280
|
+
# destination_pattern: "String",
|
1281
|
+
# retention_in_days: 1,
|
1282
|
+
# vpc_flow_log_parameters: {
|
1283
|
+
# log_format: "String",
|
1284
|
+
# traffic_type: "String",
|
1285
|
+
# max_aggregation_interval: 1,
|
1286
|
+
# },
|
1287
|
+
# },
|
1288
|
+
# scope: "String",
|
1289
|
+
# selection_criteria: "String",
|
1290
|
+
# },
|
1291
|
+
# })
|
1292
|
+
#
|
1293
|
+
# @example Response structure
|
1294
|
+
#
|
1295
|
+
# resp.rule_arn #=> String
|
1296
|
+
#
|
1297
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/observabilityadmin-2018-05-10/UpdateTelemetryRuleForOrganization AWS API Documentation
|
1298
|
+
#
|
1299
|
+
# @overload update_telemetry_rule_for_organization(params = {})
|
1300
|
+
# @param [Hash] params ({})
|
1301
|
+
def update_telemetry_rule_for_organization(params = {}, options = {})
|
1302
|
+
req = build_request(:update_telemetry_rule_for_organization, params)
|
1303
|
+
req.send_request(options)
|
1304
|
+
end
|
1305
|
+
|
750
1306
|
# @!endgroup
|
751
1307
|
|
752
1308
|
# @param params ({})
|
@@ -765,7 +1321,7 @@ module Aws::ObservabilityAdmin
|
|
765
1321
|
tracer: tracer
|
766
1322
|
)
|
767
1323
|
context[:gem_name] = 'aws-sdk-observabilityadmin'
|
768
|
-
context[:gem_version] = '1.
|
1324
|
+
context[:gem_version] = '1.9.0'
|
769
1325
|
Seahorse::Client::Request.new(handlers, context)
|
770
1326
|
end
|
771
1327
|
|