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