aws-sdk-prometheusservice 1.29.0 → 1.30.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -388,22 +388,32 @@ module Aws::PrometheusService
388
388
 
389
389
  # @!group API Operations
390
390
 
391
- # Create an alert manager definition.
392
- #
393
- # @option params [required, String] :workspace_id
394
- # The ID of the workspace in which to create the alert manager
395
- # definition.
396
- #
397
- # @option params [required, String, StringIO, File] :data
398
- # The alert manager definition data.
391
+ # The `CreateAlertManagerDefinition` operation creates the alert manager
392
+ # definition in a workspace. If a workspace already has an alert manager
393
+ # definition, don't use this operation to update it. Instead, use
394
+ # `PutAlertManagerDefinition`.
399
395
  #
400
396
  # @option params [String] :client_token
401
- # Optional, unique, case-sensitive, user-provided identifier to ensure
402
- # the idempotency of the request.
397
+ # A unique identifier that you can provide to ensure the idempotency of
398
+ # the request. Case-sensitive.
403
399
  #
404
400
  # **A suitable default value is auto-generated.** You should normally
405
401
  # not need to pass this option.**
406
402
  #
403
+ # @option params [required, String, StringIO, File] :data
404
+ # The alert manager definition to add. A base64-encoded version of the
405
+ # YAML alert manager definition file.
406
+ #
407
+ # For details about the alert manager definition, see
408
+ # [AlertManagedDefinitionData][1].
409
+ #
410
+ #
411
+ #
412
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html
413
+ #
414
+ # @option params [required, String] :workspace_id
415
+ # The ID of the workspace to add the alert manager definition to.
416
+ #
407
417
  # @return [Types::CreateAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
408
418
  #
409
419
  # * {Types::CreateAlertManagerDefinitionResponse#status #status} => Types::AlertManagerDefinitionStatus
@@ -411,9 +421,9 @@ module Aws::PrometheusService
411
421
  # @example Request syntax with placeholder values
412
422
  #
413
423
  # resp = client.create_alert_manager_definition({
414
- # workspace_id: "WorkspaceId", # required
415
- # data: "data", # required
416
424
  # client_token: "IdempotencyToken",
425
+ # data: "data", # required
426
+ # workspace_id: "WorkspaceId", # required
417
427
  # })
418
428
  #
419
429
  # @example Response structure
@@ -430,22 +440,24 @@ module Aws::PrometheusService
430
440
  req.send_request(options)
431
441
  end
432
442
 
433
- # Create logging configuration.
434
- #
435
- # @option params [required, String] :workspace_id
436
- # The ID of the workspace to vend logs to.
437
- #
438
- # @option params [required, String] :log_group_arn
439
- # The ARN of the CW log group to which the vended log data will be
440
- # published.
443
+ # The `CreateLoggingConfiguration` operation creates a logging
444
+ # configuration for the workspace. Use this operation to set the
445
+ # CloudWatch log group to which the logs will be published to.
441
446
  #
442
447
  # @option params [String] :client_token
443
- # Optional, unique, case-sensitive, user-provided identifier to ensure
444
- # the idempotency of the request.
448
+ # A unique identifier that you can provide to ensure the idempotency of
449
+ # the request. Case-sensitive.
445
450
  #
446
451
  # **A suitable default value is auto-generated.** You should normally
447
452
  # not need to pass this option.**
448
453
  #
454
+ # @option params [required, String] :log_group_arn
455
+ # The ARN of the CloudWatch log group to which the vended log data will
456
+ # be published. This log group must exist prior to calling this API.
457
+ #
458
+ # @option params [required, String] :workspace_id
459
+ # The ID of the workspace to create the logging configuration for.
460
+ #
449
461
  # @return [Types::CreateLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
450
462
  #
451
463
  # * {Types::CreateLoggingConfigurationResponse#status #status} => Types::LoggingConfigurationStatus
@@ -453,9 +465,9 @@ module Aws::PrometheusService
453
465
  # @example Request syntax with placeholder values
454
466
  #
455
467
  # resp = client.create_logging_configuration({
456
- # workspace_id: "WorkspaceId", # required
457
- # log_group_arn: "LogGroupArn", # required
458
468
  # client_token: "IdempotencyToken",
469
+ # log_group_arn: "LogGroupArn", # required
470
+ # workspace_id: "WorkspaceId", # required
459
471
  # })
460
472
  #
461
473
  # @example Response structure
@@ -472,50 +484,67 @@ module Aws::PrometheusService
472
484
  req.send_request(options)
473
485
  end
474
486
 
475
- # Create a rule group namespace.
476
- #
477
- # @option params [required, String] :workspace_id
478
- # The ID of the workspace in which to create the rule group namespace.
487
+ # The `CreateRuleGroupsNamespace` operation creates a rule groups
488
+ # namespace within a workspace. A rule groups namespace is associated
489
+ # with exactly one rules file. A workspace can have multiple rule groups
490
+ # namespaces.
479
491
  #
480
- # @option params [required, String] :name
481
- # The rule groups namespace name.
482
- #
483
- # @option params [required, String, StringIO, File] :data
484
- # The namespace data that define the rule groups.
492
+ # Use this operation only to create new rule groups namespaces. To
493
+ # update an existing rule groups namespace, use
494
+ # `PutRuleGroupsNamespace`.
485
495
  #
486
496
  # @option params [String] :client_token
487
- # Optional, unique, case-sensitive, user-provided identifier to ensure
488
- # the idempotency of the request.
497
+ # A unique identifier that you can provide to ensure the idempotency of
498
+ # the request. Case-sensitive.
489
499
  #
490
500
  # **A suitable default value is auto-generated.** You should normally
491
501
  # not need to pass this option.**
492
502
  #
503
+ # @option params [required, String, StringIO, File] :data
504
+ # The rules file to use in the new namespace.
505
+ #
506
+ # Contains the base64-encoded version of the YAML rules file.
507
+ #
508
+ # For details about the rule groups namespace structure, see
509
+ # [RuleGroupsNamespaceData][1].
510
+ #
511
+ #
512
+ #
513
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html
514
+ #
515
+ # @option params [required, String] :name
516
+ # The name for the new rule groups namespace.
517
+ #
493
518
  # @option params [Hash<String,String>] :tags
494
- # Optional, user-provided tags for this rule groups namespace.
519
+ # The list of tag keys and values to associate with the rule groups
520
+ # namespace.
521
+ #
522
+ # @option params [required, String] :workspace_id
523
+ # The ID of the workspace to add the rule groups namespace.
495
524
  #
496
525
  # @return [Types::CreateRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
497
526
  #
498
- # * {Types::CreateRuleGroupsNamespaceResponse#name #name} => String
499
527
  # * {Types::CreateRuleGroupsNamespaceResponse#arn #arn} => String
528
+ # * {Types::CreateRuleGroupsNamespaceResponse#name #name} => String
500
529
  # * {Types::CreateRuleGroupsNamespaceResponse#status #status} => Types::RuleGroupsNamespaceStatus
501
530
  # * {Types::CreateRuleGroupsNamespaceResponse#tags #tags} => Hash&lt;String,String&gt;
502
531
  #
503
532
  # @example Request syntax with placeholder values
504
533
  #
505
534
  # resp = client.create_rule_groups_namespace({
506
- # workspace_id: "WorkspaceId", # required
507
- # name: "RuleGroupsNamespaceName", # required
508
- # data: "data", # required
509
535
  # client_token: "IdempotencyToken",
536
+ # data: "data", # required
537
+ # name: "RuleGroupsNamespaceName", # required
510
538
  # tags: {
511
539
  # "TagKey" => "TagValue",
512
540
  # },
541
+ # workspace_id: "WorkspaceId", # required
513
542
  # })
514
543
  #
515
544
  # @example Response structure
516
545
  #
517
- # resp.name #=> String
518
546
  # resp.arn #=> String
547
+ # resp.name #=> String
519
548
  # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
520
549
  # resp.status.status_reason #=> String
521
550
  # resp.tags #=> Hash
@@ -530,36 +559,68 @@ module Aws::PrometheusService
530
559
  req.send_request(options)
531
560
  end
532
561
 
533
- # Create a scraper.
562
+ # The `CreateScraper` operation creates a scraper to collect metrics. A
563
+ # scraper pulls metrics from Prometheus-compatible sources within an
564
+ # Amazon EKS cluster, and sends them to your Amazon Managed Service for
565
+ # Prometheus workspace. You can configure the scraper to control what
566
+ # metrics are collected, and what transformations are applied prior to
567
+ # sending them to your workspace.
534
568
  #
535
- # @option params [String] :alias
536
- # An optional user-assigned alias for this scraper. This alias is for
537
- # user reference and does not need to be unique.
569
+ # If needed, an IAM role will be created for you that gives Amazon
570
+ # Managed Service for Prometheus access to the metrics in your cluster.
571
+ # For more information, see [Using roles for scraping metrics from
572
+ # EKS][1] in the *Amazon Managed Service for Prometheus User Guide*.
538
573
  #
539
- # @option params [required, Types::ScrapeConfiguration] :scrape_configuration
540
- # The configuration used to create the scraper.
574
+ # You cannot update a scraper. If you want to change the configuration
575
+ # of the scraper, create a new scraper and delete the old one.
541
576
  #
542
- # @option params [required, Types::Source] :source
543
- # The source that the scraper will be discovering and collecting metrics
544
- # from.
577
+ # The `scrapeConfiguration` parameter contains the base64-encoded
578
+ # version of the YAML configuration file.
579
+ #
580
+ # <note markdown="1"> For more information about collectors, including what metrics are
581
+ # collected, and how to configure the scraper, see [Amazon Web Services
582
+ # managed collectors][2] in the *Amazon Managed Service for Prometheus
583
+ # User Guide*.
584
+ #
585
+ # </note>
545
586
  #
546
- # @option params [required, Types::Destination] :destination
547
- # The destination that the scraper will be producing metrics to.
587
+ #
588
+ #
589
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper
590
+ # [2]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html
591
+ #
592
+ # @option params [String] :alias
593
+ # (optional) a name to associate with the scraper. This is for your use,
594
+ # and does not need to be unique.
548
595
  #
549
596
  # @option params [String] :client_token
550
- # Optional, unique, case-sensitive, user-provided identifier to ensure
551
- # the idempotency of the request.
597
+ # (Optional) A unique, case-sensitive identifier that you can provide to
598
+ # ensure the idempotency of the request.
552
599
  #
553
600
  # **A suitable default value is auto-generated.** You should normally
554
601
  # not need to pass this option.**
555
602
  #
603
+ # @option params [required, Types::Destination] :destination
604
+ # The Amazon Managed Service for Prometheus workspace to send metrics
605
+ # to.
606
+ #
607
+ # @option params [required, Types::ScrapeConfiguration] :scrape_configuration
608
+ # The configuration file to use in the new scraper. For more
609
+ # information, see [Scraper
610
+ # configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
611
+ # in the *Amazon Managed Service for Prometheus User Guide*.
612
+ #
613
+ # @option params [required, Types::Source] :source
614
+ # The Amazon EKS cluster from which the scraper will collect metrics.
615
+ #
556
616
  # @option params [Hash<String,String>] :tags
557
- # Optional, user-provided tags for this scraper.
617
+ # (Optional) The list of tag keys and values to associate with the
618
+ # scraper.
558
619
  #
559
620
  # @return [Types::CreateScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
560
621
  #
561
- # * {Types::CreateScraperResponse#scraper_id #scraper_id} => String
562
622
  # * {Types::CreateScraperResponse#arn #arn} => String
623
+ # * {Types::CreateScraperResponse#scraper_id #scraper_id} => String
563
624
  # * {Types::CreateScraperResponse#status #status} => Types::ScraperStatus
564
625
  # * {Types::CreateScraperResponse#tags #tags} => Hash&lt;String,String&gt;
565
626
  #
@@ -567,6 +628,12 @@ module Aws::PrometheusService
567
628
  #
568
629
  # resp = client.create_scraper({
569
630
  # alias: "ScraperAlias",
631
+ # client_token: "IdempotencyToken",
632
+ # destination: { # required
633
+ # amp_configuration: {
634
+ # workspace_arn: "WorkspaceArn", # required
635
+ # },
636
+ # },
570
637
  # scrape_configuration: { # required
571
638
  # configuration_blob: "data",
572
639
  # },
@@ -577,12 +644,6 @@ module Aws::PrometheusService
577
644
  # subnet_ids: ["SubnetId"], # required
578
645
  # },
579
646
  # },
580
- # destination: { # required
581
- # amp_configuration: {
582
- # workspace_arn: "WorkspaceArn", # required
583
- # },
584
- # },
585
- # client_token: "IdempotencyToken",
586
647
  # tags: {
587
648
  # "TagKey" => "TagValue",
588
649
  # },
@@ -590,8 +651,8 @@ module Aws::PrometheusService
590
651
  #
591
652
  # @example Response structure
592
653
  #
593
- # resp.scraper_id #=> String
594
654
  # resp.arn #=> String
655
+ # resp.scraper_id #=> String
595
656
  # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
596
657
  # resp.tags #=> Hash
597
658
  # resp.tags["TagKey"] #=> String
@@ -605,53 +666,64 @@ module Aws::PrometheusService
605
666
  req.send_request(options)
606
667
  end
607
668
 
608
- # Creates a new AMP workspace.
669
+ # Creates a Prometheus workspace. A workspace is a logical space
670
+ # dedicated to the storage and querying of Prometheus metrics. You can
671
+ # have one or more workspaces in each Region in your account.
609
672
  #
610
673
  # @option params [String] :alias
611
- # An optional user-assigned alias for this workspace. This alias is for
612
- # user reference and does not need to be unique.
674
+ # An alias that you assign to this workspace to help you identify it. It
675
+ # does not need to be unique.
676
+ #
677
+ # Blank spaces at the beginning or end of the alias that you specify
678
+ # will be trimmed from the value used.
613
679
  #
614
680
  # @option params [String] :client_token
615
- # Optional, unique, case-sensitive, user-provided identifier to ensure
616
- # the idempotency of the request.
681
+ # A unique identifier that you can provide to ensure the idempotency of
682
+ # the request. Case-sensitive.
617
683
  #
618
684
  # **A suitable default value is auto-generated.** You should normally
619
685
  # not need to pass this option.**
620
686
  #
621
- # @option params [Hash<String,String>] :tags
622
- # Optional, user-provided tags for this workspace.
623
- #
624
687
  # @option params [String] :kms_key_arn
625
- # Optional, customer managed KMS key used to encrypt data for this
626
- # workspace
688
+ # (optional) The ARN for a customer managed KMS key to use for
689
+ # encrypting data within your workspace. For more information about
690
+ # using your own key in your workspace, see [Encryption at rest][1] in
691
+ # the *Amazon Managed Service for Prometheus User Guide*.
692
+ #
693
+ #
694
+ #
695
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html
696
+ #
697
+ # @option params [Hash<String,String>] :tags
698
+ # The list of tag keys and values to associate with the workspace.
627
699
  #
628
700
  # @return [Types::CreateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
629
701
  #
630
- # * {Types::CreateWorkspaceResponse#workspace_id #workspace_id} => String
631
702
  # * {Types::CreateWorkspaceResponse#arn #arn} => String
703
+ # * {Types::CreateWorkspaceResponse#kms_key_arn #kms_key_arn} => String
632
704
  # * {Types::CreateWorkspaceResponse#status #status} => Types::WorkspaceStatus
633
705
  # * {Types::CreateWorkspaceResponse#tags #tags} => Hash&lt;String,String&gt;
634
- # * {Types::CreateWorkspaceResponse#kms_key_arn #kms_key_arn} => String
706
+ # * {Types::CreateWorkspaceResponse#workspace_id #workspace_id} => String
635
707
  #
636
708
  # @example Request syntax with placeholder values
637
709
  #
638
710
  # resp = client.create_workspace({
639
711
  # alias: "WorkspaceAlias",
640
712
  # client_token: "IdempotencyToken",
713
+ # kms_key_arn: "KmsKeyArn",
641
714
  # tags: {
642
715
  # "TagKey" => "TagValue",
643
716
  # },
644
- # kms_key_arn: "KmsKeyArn",
645
717
  # })
646
718
  #
647
719
  # @example Response structure
648
720
  #
649
- # resp.workspace_id #=> String
650
721
  # resp.arn #=> String
722
+ # resp.kms_key_arn #=> String
651
723
  # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
652
724
  # resp.tags #=> Hash
653
725
  # resp.tags["TagKey"] #=> String
654
- # resp.kms_key_arn #=> String
726
+ # resp.workspace_id #=> String
655
727
  #
656
728
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspace AWS API Documentation
657
729
  #
@@ -662,26 +734,25 @@ module Aws::PrometheusService
662
734
  req.send_request(options)
663
735
  end
664
736
 
665
- # Deletes an alert manager definition.
666
- #
667
- # @option params [required, String] :workspace_id
668
- # The ID of the workspace in which to delete the alert manager
669
- # definition.
737
+ # Deletes the alert manager definition from a workspace.
670
738
  #
671
739
  # @option params [String] :client_token
672
- # Optional, unique, case-sensitive, user-provided identifier to ensure
673
- # the idempotency of the request.
740
+ # A unique identifier that you can provide to ensure the idempotency of
741
+ # the request. Case-sensitive.
674
742
  #
675
743
  # **A suitable default value is auto-generated.** You should normally
676
744
  # not need to pass this option.**
677
745
  #
746
+ # @option params [required, String] :workspace_id
747
+ # The ID of the workspace to delete the alert manager definition from.
748
+ #
678
749
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
679
750
  #
680
751
  # @example Request syntax with placeholder values
681
752
  #
682
753
  # resp = client.delete_alert_manager_definition({
683
- # workspace_id: "WorkspaceId", # required
684
754
  # client_token: "IdempotencyToken",
755
+ # workspace_id: "WorkspaceId", # required
685
756
  # })
686
757
  #
687
758
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteAlertManagerDefinition AWS API Documentation
@@ -693,25 +764,26 @@ module Aws::PrometheusService
693
764
  req.send_request(options)
694
765
  end
695
766
 
696
- # Delete logging configuration.
697
- #
698
- # @option params [required, String] :workspace_id
699
- # The ID of the workspace to vend logs to.
767
+ # Deletes the logging configuration for a workspace.
700
768
  #
701
769
  # @option params [String] :client_token
702
- # Optional, unique, case-sensitive, user-provided identifier to ensure
703
- # the idempotency of the request.
770
+ # A unique identifier that you can provide to ensure the idempotency of
771
+ # the request. Case-sensitive.
704
772
  #
705
773
  # **A suitable default value is auto-generated.** You should normally
706
774
  # not need to pass this option.**
707
775
  #
776
+ # @option params [required, String] :workspace_id
777
+ # The ID of the workspace containing the logging configuration to
778
+ # delete.
779
+ #
708
780
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
709
781
  #
710
782
  # @example Request syntax with placeholder values
711
783
  #
712
784
  # resp = client.delete_logging_configuration({
713
- # workspace_id: "WorkspaceId", # required
714
785
  # client_token: "IdempotencyToken",
786
+ # workspace_id: "WorkspaceId", # required
715
787
  # })
716
788
  #
717
789
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteLoggingConfiguration AWS API Documentation
@@ -723,29 +795,31 @@ module Aws::PrometheusService
723
795
  req.send_request(options)
724
796
  end
725
797
 
726
- # Delete a rule groups namespace.
727
- #
728
- # @option params [required, String] :workspace_id
729
- # The ID of the workspace to delete rule group definition.
730
- #
731
- # @option params [required, String] :name
732
- # The rule groups namespace name.
798
+ # Deletes one rule groups namespace and its associated rule groups
799
+ # definition.
733
800
  #
734
801
  # @option params [String] :client_token
735
- # Optional, unique, case-sensitive, user-provided identifier to ensure
736
- # the idempotency of the request.
802
+ # A unique identifier that you can provide to ensure the idempotency of
803
+ # the request. Case-sensitive.
737
804
  #
738
805
  # **A suitable default value is auto-generated.** You should normally
739
806
  # not need to pass this option.**
740
807
  #
808
+ # @option params [required, String] :name
809
+ # The name of the rule groups namespace to delete.
810
+ #
811
+ # @option params [required, String] :workspace_id
812
+ # The ID of the workspace containing the rule groups namespace and
813
+ # definition to delete.
814
+ #
741
815
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
742
816
  #
743
817
  # @example Request syntax with placeholder values
744
818
  #
745
819
  # resp = client.delete_rule_groups_namespace({
746
- # workspace_id: "WorkspaceId", # required
747
- # name: "RuleGroupsNamespaceName", # required
748
820
  # client_token: "IdempotencyToken",
821
+ # name: "RuleGroupsNamespaceName", # required
822
+ # workspace_id: "WorkspaceId", # required
749
823
  # })
750
824
  #
751
825
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteRuleGroupsNamespace AWS API Documentation
@@ -757,18 +831,19 @@ module Aws::PrometheusService
757
831
  req.send_request(options)
758
832
  end
759
833
 
760
- # Deletes a scraper.
761
- #
762
- # @option params [required, String] :scraper_id
763
- # The ID of the scraper to delete.
834
+ # The `DeleteScraper` operation deletes one scraper, and stops any
835
+ # metrics collection that the scraper performs.
764
836
  #
765
837
  # @option params [String] :client_token
766
- # Optional, unique, case-sensitive, user-provided identifier to ensure
767
- # the idempotency of the request.
838
+ # (Optional) A unique, case-sensitive identifier that you can provide to
839
+ # ensure the idempotency of the request.
768
840
  #
769
841
  # **A suitable default value is auto-generated.** You should normally
770
842
  # not need to pass this option.**
771
843
  #
844
+ # @option params [required, String] :scraper_id
845
+ # The ID of the scraper to delete.
846
+ #
772
847
  # @return [Types::DeleteScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
773
848
  #
774
849
  # * {Types::DeleteScraperResponse#scraper_id #scraper_id} => String
@@ -777,8 +852,8 @@ module Aws::PrometheusService
777
852
  # @example Request syntax with placeholder values
778
853
  #
779
854
  # resp = client.delete_scraper({
780
- # scraper_id: "ScraperId", # required
781
855
  # client_token: "IdempotencyToken",
856
+ # scraper_id: "ScraperId", # required
782
857
  # })
783
858
  #
784
859
  # @example Response structure
@@ -795,25 +870,31 @@ module Aws::PrometheusService
795
870
  req.send_request(options)
796
871
  end
797
872
 
798
- # Deletes an AMP workspace.
873
+ # Deletes an existing workspace.
799
874
  #
800
- # @option params [required, String] :workspace_id
801
- # The ID of the workspace to delete.
875
+ # <note markdown="1"> When you delete a workspace, the data that has been ingested into it
876
+ # is not immediately deleted. It will be permanently deleted within one
877
+ # month.
878
+ #
879
+ # </note>
802
880
  #
803
881
  # @option params [String] :client_token
804
- # Optional, unique, case-sensitive, user-provided identifier to ensure
805
- # the idempotency of the request.
882
+ # A unique identifier that you can provide to ensure the idempotency of
883
+ # the request. Case-sensitive.
806
884
  #
807
885
  # **A suitable default value is auto-generated.** You should normally
808
886
  # not need to pass this option.**
809
887
  #
888
+ # @option params [required, String] :workspace_id
889
+ # The ID of the workspace to delete.
890
+ #
810
891
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
811
892
  #
812
893
  # @example Request syntax with placeholder values
813
894
  #
814
895
  # resp = client.delete_workspace({
815
- # workspace_id: "WorkspaceId", # required
816
896
  # client_token: "IdempotencyToken",
897
+ # workspace_id: "WorkspaceId", # required
817
898
  # })
818
899
  #
819
900
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteWorkspace AWS API Documentation
@@ -825,10 +906,11 @@ module Aws::PrometheusService
825
906
  req.send_request(options)
826
907
  end
827
908
 
828
- # Describes an alert manager definition.
909
+ # Retrieves the full information about the alert manager definition for
910
+ # a workspace.
829
911
  #
830
912
  # @option params [required, String] :workspace_id
831
- # The ID of the workspace to describe.
913
+ # The ID of the workspace to retrieve the alert manager definition from.
832
914
  #
833
915
  # @return [Types::DescribeAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
834
916
  #
@@ -842,11 +924,11 @@ module Aws::PrometheusService
842
924
  #
843
925
  # @example Response structure
844
926
  #
845
- # resp.alert_manager_definition.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
846
- # resp.alert_manager_definition.status.status_reason #=> String
847
- # resp.alert_manager_definition.data #=> String
848
927
  # resp.alert_manager_definition.created_at #=> Time
928
+ # resp.alert_manager_definition.data #=> String
849
929
  # resp.alert_manager_definition.modified_at #=> Time
930
+ # resp.alert_manager_definition.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
931
+ # resp.alert_manager_definition.status.status_reason #=> String
850
932
  #
851
933
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAlertManagerDefinition AWS API Documentation
852
934
  #
@@ -857,10 +939,11 @@ module Aws::PrometheusService
857
939
  req.send_request(options)
858
940
  end
859
941
 
860
- # Describes logging configuration.
942
+ # Returns complete information about the current logging configuration
943
+ # of the workspace.
861
944
  #
862
945
  # @option params [required, String] :workspace_id
863
- # The ID of the workspace to vend logs to.
946
+ # The ID of the workspace to describe the logging configuration for.
864
947
  #
865
948
  # @return [Types::DescribeLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
866
949
  #
@@ -874,12 +957,12 @@ module Aws::PrometheusService
874
957
  #
875
958
  # @example Response structure
876
959
  #
960
+ # resp.logging_configuration.created_at #=> Time
961
+ # resp.logging_configuration.log_group_arn #=> String
962
+ # resp.logging_configuration.modified_at #=> Time
877
963
  # resp.logging_configuration.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
878
964
  # resp.logging_configuration.status.status_reason #=> String
879
965
  # resp.logging_configuration.workspace #=> String
880
- # resp.logging_configuration.log_group_arn #=> String
881
- # resp.logging_configuration.created_at #=> Time
882
- # resp.logging_configuration.modified_at #=> Time
883
966
  #
884
967
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeLoggingConfiguration AWS API Documentation
885
968
  #
@@ -890,13 +973,15 @@ module Aws::PrometheusService
890
973
  req.send_request(options)
891
974
  end
892
975
 
893
- # Describe a rule groups namespace.
894
- #
895
- # @option params [required, String] :workspace_id
896
- # The ID of the workspace to describe.
976
+ # Returns complete information about one rule groups namespace. To
977
+ # retrieve a list of rule groups namespaces, use
978
+ # `ListRuleGroupsNamespaces`.
897
979
  #
898
980
  # @option params [required, String] :name
899
- # The rule groups namespace.
981
+ # The name of the rule groups namespace that you want information for.
982
+ #
983
+ # @option params [required, String] :workspace_id
984
+ # The ID of the workspace containing the rule groups namespace.
900
985
  #
901
986
  # @return [Types::DescribeRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
902
987
  #
@@ -905,19 +990,19 @@ module Aws::PrometheusService
905
990
  # @example Request syntax with placeholder values
906
991
  #
907
992
  # resp = client.describe_rule_groups_namespace({
908
- # workspace_id: "WorkspaceId", # required
909
993
  # name: "RuleGroupsNamespaceName", # required
994
+ # workspace_id: "WorkspaceId", # required
910
995
  # })
911
996
  #
912
997
  # @example Response structure
913
998
  #
914
999
  # resp.rule_groups_namespace.arn #=> String
1000
+ # resp.rule_groups_namespace.created_at #=> Time
1001
+ # resp.rule_groups_namespace.data #=> String
1002
+ # resp.rule_groups_namespace.modified_at #=> Time
915
1003
  # resp.rule_groups_namespace.name #=> String
916
1004
  # resp.rule_groups_namespace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
917
1005
  # resp.rule_groups_namespace.status.status_reason #=> String
918
- # resp.rule_groups_namespace.data #=> String
919
- # resp.rule_groups_namespace.created_at #=> Time
920
- # resp.rule_groups_namespace.modified_at #=> Time
921
1006
  # resp.rule_groups_namespace.tags #=> Hash
922
1007
  # resp.rule_groups_namespace.tags["TagKey"] #=> String
923
1008
  #
@@ -930,10 +1015,11 @@ module Aws::PrometheusService
930
1015
  req.send_request(options)
931
1016
  end
932
1017
 
933
- # Describe an existing scraper.
1018
+ # The `DescribeScraper` operation displays information about an existing
1019
+ # scraper.
934
1020
  #
935
1021
  # @option params [required, String] :scraper_id
936
- # The IDs of the scraper to describe.
1022
+ # The ID of the scraper to describe.
937
1023
  #
938
1024
  # @return [Types::DescribeScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
939
1025
  #
@@ -948,22 +1034,22 @@ module Aws::PrometheusService
948
1034
  # @example Response structure
949
1035
  #
950
1036
  # resp.scraper.alias #=> String
951
- # resp.scraper.scraper_id #=> String
952
1037
  # resp.scraper.arn #=> String
953
- # resp.scraper.role_arn #=> String
954
- # resp.scraper.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
955
1038
  # resp.scraper.created_at #=> Time
1039
+ # resp.scraper.destination.amp_configuration.workspace_arn #=> String
956
1040
  # resp.scraper.last_modified_at #=> Time
957
- # resp.scraper.tags #=> Hash
958
- # resp.scraper.tags["TagKey"] #=> String
959
- # resp.scraper.status_reason #=> String
1041
+ # resp.scraper.role_arn #=> String
960
1042
  # resp.scraper.scrape_configuration.configuration_blob #=> String
1043
+ # resp.scraper.scraper_id #=> String
961
1044
  # resp.scraper.source.eks_configuration.cluster_arn #=> String
962
1045
  # resp.scraper.source.eks_configuration.security_group_ids #=> Array
963
1046
  # resp.scraper.source.eks_configuration.security_group_ids[0] #=> String
964
1047
  # resp.scraper.source.eks_configuration.subnet_ids #=> Array
965
1048
  # resp.scraper.source.eks_configuration.subnet_ids[0] #=> String
966
- # resp.scraper.destination.amp_configuration.workspace_arn #=> String
1049
+ # resp.scraper.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
1050
+ # resp.scraper.status_reason #=> String
1051
+ # resp.scraper.tags #=> Hash
1052
+ # resp.scraper.tags["TagKey"] #=> String
967
1053
  #
968
1054
  #
969
1055
  # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -980,7 +1066,7 @@ module Aws::PrometheusService
980
1066
  req.send_request(options)
981
1067
  end
982
1068
 
983
- # Describes an existing AMP workspace.
1069
+ # Returns information about an existing workspace.
984
1070
  #
985
1071
  # @option params [required, String] :workspace_id
986
1072
  # The ID of the workspace to describe.
@@ -997,15 +1083,15 @@ module Aws::PrometheusService
997
1083
  #
998
1084
  # @example Response structure
999
1085
  #
1000
- # resp.workspace.workspace_id #=> String
1001
1086
  # resp.workspace.alias #=> String
1002
1087
  # resp.workspace.arn #=> String
1003
- # resp.workspace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
1004
- # resp.workspace.prometheus_endpoint #=> String
1005
1088
  # resp.workspace.created_at #=> Time
1089
+ # resp.workspace.kms_key_arn #=> String
1090
+ # resp.workspace.prometheus_endpoint #=> String
1091
+ # resp.workspace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
1006
1092
  # resp.workspace.tags #=> Hash
1007
1093
  # resp.workspace.tags["TagKey"] #=> String
1008
- # resp.workspace.kms_key_arn #=> String
1094
+ # resp.workspace.workspace_id #=> String
1009
1095
  #
1010
1096
  #
1011
1097
  # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -1022,7 +1108,8 @@ module Aws::PrometheusService
1022
1108
  req.send_request(options)
1023
1109
  end
1024
1110
 
1025
- # Gets a default configuration.
1111
+ # The `GetDefaultScraperConfiguration` operation returns the default
1112
+ # scraper configuration used when Amazon EKS creates a scraper for you.
1026
1113
  #
1027
1114
  # @return [Types::GetDefaultScraperConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1028
1115
  #
@@ -1041,51 +1128,57 @@ module Aws::PrometheusService
1041
1128
  req.send_request(options)
1042
1129
  end
1043
1130
 
1044
- # Lists rule groups namespaces.
1131
+ # Returns a list of rule groups namespaces in a workspace.
1045
1132
  #
1046
- # @option params [required, String] :workspace_id
1047
- # The ID of the workspace.
1133
+ # @option params [Integer] :max_results
1134
+ # The maximum number of results to return. The default is 100.
1048
1135
  #
1049
1136
  # @option params [String] :name
1050
- # Optional filter for rule groups namespace name. Only the rule groups
1051
- # namespace that begin with this value will be returned.
1137
+ # Use this parameter to filter the rule groups namespaces that are
1138
+ # returned. Only the namespaces with names that begin with the value
1139
+ # that you specify are returned.
1052
1140
  #
1053
1141
  # @option params [String] :next_token
1054
- # Pagination token to request the next page in a paginated list. This
1055
- # token is obtained from the output of the previous
1056
- # ListRuleGroupsNamespaces request.
1142
+ # The token for the next set of items to return. You receive this token
1143
+ # from a previous call, and use it to get the next page of results. The
1144
+ # other parameters must be the same as the initial call.
1057
1145
  #
1058
- # @option params [Integer] :max_results
1059
- # Maximum results to return in response (default=100, maximum=1000).
1146
+ # For example, if your initial request has `maxResults` of 10, and there
1147
+ # are 12 rule groups namespaces to return, then your initial request
1148
+ # will return 10 and a `nextToken`. Using the next token in a subsequent
1149
+ # call will return the remaining 2 namespaces.
1150
+ #
1151
+ # @option params [required, String] :workspace_id
1152
+ # The ID of the workspace containing the rule groups namespaces.
1060
1153
  #
1061
1154
  # @return [Types::ListRuleGroupsNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1062
1155
  #
1063
- # * {Types::ListRuleGroupsNamespacesResponse#rule_groups_namespaces #rule_groups_namespaces} => Array&lt;Types::RuleGroupsNamespaceSummary&gt;
1064
1156
  # * {Types::ListRuleGroupsNamespacesResponse#next_token #next_token} => String
1157
+ # * {Types::ListRuleGroupsNamespacesResponse#rule_groups_namespaces #rule_groups_namespaces} => Array&lt;Types::RuleGroupsNamespaceSummary&gt;
1065
1158
  #
1066
1159
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1067
1160
  #
1068
1161
  # @example Request syntax with placeholder values
1069
1162
  #
1070
1163
  # resp = client.list_rule_groups_namespaces({
1071
- # workspace_id: "WorkspaceId", # required
1164
+ # max_results: 1,
1072
1165
  # name: "RuleGroupsNamespaceName",
1073
1166
  # next_token: "PaginationToken",
1074
- # max_results: 1,
1167
+ # workspace_id: "WorkspaceId", # required
1075
1168
  # })
1076
1169
  #
1077
1170
  # @example Response structure
1078
1171
  #
1172
+ # resp.next_token #=> String
1079
1173
  # resp.rule_groups_namespaces #=> Array
1080
1174
  # resp.rule_groups_namespaces[0].arn #=> String
1175
+ # resp.rule_groups_namespaces[0].created_at #=> Time
1176
+ # resp.rule_groups_namespaces[0].modified_at #=> Time
1081
1177
  # resp.rule_groups_namespaces[0].name #=> String
1082
1178
  # resp.rule_groups_namespaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
1083
1179
  # resp.rule_groups_namespaces[0].status.status_reason #=> String
1084
- # resp.rule_groups_namespaces[0].created_at #=> Time
1085
- # resp.rule_groups_namespaces[0].modified_at #=> Time
1086
1180
  # resp.rule_groups_namespaces[0].tags #=> Hash
1087
1181
  # resp.rule_groups_namespaces[0].tags["TagKey"] #=> String
1088
- # resp.next_token #=> String
1089
1182
  #
1090
1183
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespaces AWS API Documentation
1091
1184
  #
@@ -1096,25 +1189,43 @@ module Aws::PrometheusService
1096
1189
  req.send_request(options)
1097
1190
  end
1098
1191
 
1099
- # Lists all scrapers in a customer account, including scrapers being
1100
- # created or deleted. You may provide filters to return a more specific
1101
- # list of results.
1192
+ # The `ListScrapers` operation lists all of the scrapers in your
1193
+ # account. This includes scrapers being created or deleted. You can
1194
+ # optionally filter the returned list.
1102
1195
  #
1103
1196
  # @option params [Hash<String,Array>] :filters
1104
- # A list of scraper filters.
1197
+ # (Optional) A list of key-value pairs to filter the list of scrapers
1198
+ # returned. Keys include `status`, `sourceArn`, `destinationArn`, and
1199
+ # `alias`.
1105
1200
  #
1106
- # @option params [String] :next_token
1107
- # Pagination token to request the next page in a paginated list. This
1108
- # token is obtained from the output of the previous ListScrapers
1109
- # request.
1201
+ # Filters on the same key are `OR`'d together, and filters on different
1202
+ # keys are `AND`'d together. For example,
1203
+ # `status=ACTIVE&status=CREATING&alias=Test`, will return all scrapers
1204
+ # that have the alias Test, and are either in status ACTIVE or CREATING.
1205
+ #
1206
+ # To find all active scrapers that are sending metrics to a specific
1207
+ # Amazon Managed Service for Prometheus workspace, you would use the ARN
1208
+ # of the workspace in a query:
1209
+ #
1210
+ # `status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012`
1211
+ #
1212
+ # If this is included, it filters the results to only the scrapers that
1213
+ # match the filter.
1110
1214
  #
1111
1215
  # @option params [Integer] :max_results
1112
- # Maximum results to return in response (default=100, maximum=1000).
1216
+ # Optional) The maximum number of scrapers to return in one
1217
+ # `ListScrapers` operation. The range is 1-1000.
1218
+ #
1219
+ # If you omit this parameter, the default of 100 is used.
1220
+ #
1221
+ # @option params [String] :next_token
1222
+ # (Optional) The token for the next set of items to return. (You
1223
+ # received this token from a previous call.)
1113
1224
  #
1114
1225
  # @return [Types::ListScrapersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1115
1226
  #
1116
- # * {Types::ListScrapersResponse#scrapers #scrapers} => Array&lt;Types::ScraperSummary&gt;
1117
1227
  # * {Types::ListScrapersResponse#next_token #next_token} => String
1228
+ # * {Types::ListScrapersResponse#scrapers #scrapers} => Array&lt;Types::ScraperSummary&gt;
1118
1229
  #
1119
1230
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1120
1231
  #
@@ -1124,30 +1235,30 @@ module Aws::PrometheusService
1124
1235
  # filters: {
1125
1236
  # "FilterKey" => ["FilterValue"],
1126
1237
  # },
1127
- # next_token: "PaginationToken",
1128
1238
  # max_results: 1,
1239
+ # next_token: "PaginationToken",
1129
1240
  # })
1130
1241
  #
1131
1242
  # @example Response structure
1132
1243
  #
1244
+ # resp.next_token #=> String
1133
1245
  # resp.scrapers #=> Array
1134
1246
  # resp.scrapers[0].alias #=> String
1135
- # resp.scrapers[0].scraper_id #=> String
1136
1247
  # resp.scrapers[0].arn #=> String
1137
- # resp.scrapers[0].role_arn #=> String
1138
- # resp.scrapers[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
1139
1248
  # resp.scrapers[0].created_at #=> Time
1249
+ # resp.scrapers[0].destination.amp_configuration.workspace_arn #=> String
1140
1250
  # resp.scrapers[0].last_modified_at #=> Time
1141
- # resp.scrapers[0].tags #=> Hash
1142
- # resp.scrapers[0].tags["TagKey"] #=> String
1143
- # resp.scrapers[0].status_reason #=> String
1251
+ # resp.scrapers[0].role_arn #=> String
1252
+ # resp.scrapers[0].scraper_id #=> String
1144
1253
  # resp.scrapers[0].source.eks_configuration.cluster_arn #=> String
1145
1254
  # resp.scrapers[0].source.eks_configuration.security_group_ids #=> Array
1146
1255
  # resp.scrapers[0].source.eks_configuration.security_group_ids[0] #=> String
1147
1256
  # resp.scrapers[0].source.eks_configuration.subnet_ids #=> Array
1148
1257
  # resp.scrapers[0].source.eks_configuration.subnet_ids[0] #=> String
1149
- # resp.scrapers[0].destination.amp_configuration.workspace_arn #=> String
1150
- # resp.next_token #=> String
1258
+ # resp.scrapers[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
1259
+ # resp.scrapers[0].status_reason #=> String
1260
+ # resp.scrapers[0].tags #=> Hash
1261
+ # resp.scrapers[0].tags["TagKey"] #=> String
1151
1262
  #
1152
1263
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListScrapers AWS API Documentation
1153
1264
  #
@@ -1158,10 +1269,14 @@ module Aws::PrometheusService
1158
1269
  req.send_request(options)
1159
1270
  end
1160
1271
 
1161
- # Lists the tags you have assigned to the resource.
1272
+ # The `ListTagsForResource` operation returns the tags that are
1273
+ # associated with an Amazon Managed Service for Prometheus resource.
1274
+ # Currently, the only resources that can be tagged are workspaces and
1275
+ # rule groups namespaces.
1162
1276
  #
1163
1277
  # @option params [required, String] :resource_arn
1164
- # The ARN of the resource.
1278
+ # The ARN of the resource to list tages for. Must be a workspace or rule
1279
+ # groups namespace resource.
1165
1280
  #
1166
1281
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1167
1282
  #
@@ -1187,48 +1302,57 @@ module Aws::PrometheusService
1187
1302
  req.send_request(options)
1188
1303
  end
1189
1304
 
1190
- # Lists all AMP workspaces, including workspaces being created or
1191
- # deleted.
1192
- #
1193
- # @option params [String] :next_token
1194
- # Pagination token to request the next page in a paginated list. This
1195
- # token is obtained from the output of the previous ListWorkspaces
1196
- # request.
1305
+ # Lists all of the Amazon Managed Service for Prometheus workspaces in
1306
+ # your account. This includes workspaces being created or deleted.
1197
1307
  #
1198
1308
  # @option params [String] :alias
1199
- # Optional filter for workspace alias. Only the workspaces with aliases
1200
- # that begin with this value will be returned.
1309
+ # If this is included, it filters the results to only the workspaces
1310
+ # with names that start with the value that you specify here.
1311
+ #
1312
+ # Amazon Managed Service for Prometheus will automatically strip any
1313
+ # blank spaces from the beginning and end of the alias that you specify.
1201
1314
  #
1202
1315
  # @option params [Integer] :max_results
1203
- # Maximum results to return in response (default=100, maximum=1000).
1316
+ # The maximum number of workspaces to return per request. The default is
1317
+ # 100.
1318
+ #
1319
+ # @option params [String] :next_token
1320
+ # The token for the next set of items to return. You receive this token
1321
+ # from a previous call, and use it to get the next page of results. The
1322
+ # other parameters must be the same as the initial call.
1323
+ #
1324
+ # For example, if your initial request has `maxResults` of 10, and there
1325
+ # are 12 workspaces to return, then your initial request will return 10
1326
+ # and a `nextToken`. Using the next token in a subsequent call will
1327
+ # return the remaining 2 workspaces.
1204
1328
  #
1205
1329
  # @return [Types::ListWorkspacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1206
1330
  #
1207
- # * {Types::ListWorkspacesResponse#workspaces #workspaces} => Array&lt;Types::WorkspaceSummary&gt;
1208
1331
  # * {Types::ListWorkspacesResponse#next_token #next_token} => String
1332
+ # * {Types::ListWorkspacesResponse#workspaces #workspaces} => Array&lt;Types::WorkspaceSummary&gt;
1209
1333
  #
1210
1334
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1211
1335
  #
1212
1336
  # @example Request syntax with placeholder values
1213
1337
  #
1214
1338
  # resp = client.list_workspaces({
1215
- # next_token: "PaginationToken",
1216
1339
  # alias: "WorkspaceAlias",
1217
1340
  # max_results: 1,
1341
+ # next_token: "PaginationToken",
1218
1342
  # })
1219
1343
  #
1220
1344
  # @example Response structure
1221
1345
  #
1346
+ # resp.next_token #=> String
1222
1347
  # resp.workspaces #=> Array
1223
- # resp.workspaces[0].workspace_id #=> String
1224
1348
  # resp.workspaces[0].alias #=> String
1225
1349
  # resp.workspaces[0].arn #=> String
1226
- # resp.workspaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
1227
1350
  # resp.workspaces[0].created_at #=> Time
1351
+ # resp.workspaces[0].kms_key_arn #=> String
1352
+ # resp.workspaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
1228
1353
  # resp.workspaces[0].tags #=> Hash
1229
1354
  # resp.workspaces[0].tags["TagKey"] #=> String
1230
- # resp.workspaces[0].kms_key_arn #=> String
1231
- # resp.next_token #=> String
1355
+ # resp.workspaces[0].workspace_id #=> String
1232
1356
  #
1233
1357
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspaces AWS API Documentation
1234
1358
  #
@@ -1239,22 +1363,32 @@ module Aws::PrometheusService
1239
1363
  req.send_request(options)
1240
1364
  end
1241
1365
 
1242
- # Update an alert manager definition.
1243
- #
1244
- # @option params [required, String] :workspace_id
1245
- # The ID of the workspace in which to update the alert manager
1246
- # definition.
1247
- #
1248
- # @option params [required, String, StringIO, File] :data
1249
- # The alert manager definition data.
1366
+ # Updates an existing alert manager definition in a workspace. If the
1367
+ # workspace does not already have an alert manager definition, don't
1368
+ # use this operation to create it. Instead, use
1369
+ # `CreateAlertManagerDefinition`.
1250
1370
  #
1251
1371
  # @option params [String] :client_token
1252
- # Optional, unique, case-sensitive, user-provided identifier to ensure
1253
- # the idempotency of the request.
1372
+ # A unique identifier that you can provide to ensure the idempotency of
1373
+ # the request. Case-sensitive.
1254
1374
  #
1255
1375
  # **A suitable default value is auto-generated.** You should normally
1256
1376
  # not need to pass this option.**
1257
1377
  #
1378
+ # @option params [required, String, StringIO, File] :data
1379
+ # The alert manager definition to use. A base64-encoded version of the
1380
+ # YAML alert manager definition file.
1381
+ #
1382
+ # For details about the alert manager definition, see
1383
+ # [AlertManagedDefinitionData][1].
1384
+ #
1385
+ #
1386
+ #
1387
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html
1388
+ #
1389
+ # @option params [required, String] :workspace_id
1390
+ # The ID of the workspace to update the alert manager definition in.
1391
+ #
1258
1392
  # @return [Types::PutAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1259
1393
  #
1260
1394
  # * {Types::PutAlertManagerDefinitionResponse#status #status} => Types::AlertManagerDefinitionStatus
@@ -1262,9 +1396,9 @@ module Aws::PrometheusService
1262
1396
  # @example Request syntax with placeholder values
1263
1397
  #
1264
1398
  # resp = client.put_alert_manager_definition({
1265
- # workspace_id: "WorkspaceId", # required
1266
- # data: "data", # required
1267
1399
  # client_token: "IdempotencyToken",
1400
+ # data: "data", # required
1401
+ # workspace_id: "WorkspaceId", # required
1268
1402
  # })
1269
1403
  #
1270
1404
  # @example Response structure
@@ -1281,44 +1415,61 @@ module Aws::PrometheusService
1281
1415
  req.send_request(options)
1282
1416
  end
1283
1417
 
1284
- # Update a rule groups namespace.
1418
+ # Updates an existing rule groups namespace within a workspace. A rule
1419
+ # groups namespace is associated with exactly one rules file. A
1420
+ # workspace can have multiple rule groups namespaces.
1285
1421
  #
1286
- # @option params [required, String] :workspace_id
1287
- # The ID of the workspace in which to update the rule group namespace.
1422
+ # Use this operation only to update existing rule groups namespaces. To
1423
+ # create a new rule groups namespace, use `CreateRuleGroupsNamespace`.
1288
1424
  #
1289
- # @option params [required, String] :name
1290
- # The rule groups namespace name.
1291
- #
1292
- # @option params [required, String, StringIO, File] :data
1293
- # The namespace data that define the rule groups.
1425
+ # You can't use this operation to add tags to an existing rule groups
1426
+ # namespace. Instead, use `TagResource`.
1294
1427
  #
1295
1428
  # @option params [String] :client_token
1296
- # Optional, unique, case-sensitive, user-provided identifier to ensure
1297
- # the idempotency of the request.
1429
+ # A unique identifier that you can provide to ensure the idempotency of
1430
+ # the request. Case-sensitive.
1298
1431
  #
1299
1432
  # **A suitable default value is auto-generated.** You should normally
1300
1433
  # not need to pass this option.**
1301
1434
  #
1435
+ # @option params [required, String, StringIO, File] :data
1436
+ # The new rules file to use in the namespace. A base64-encoded version
1437
+ # of the YAML rule groups file.
1438
+ #
1439
+ # For details about the rule groups namespace structure, see
1440
+ # [RuleGroupsNamespaceData][1].
1441
+ #
1442
+ #
1443
+ #
1444
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html
1445
+ #
1446
+ # @option params [required, String] :name
1447
+ # The name of the rule groups namespace that you are updating.
1448
+ #
1449
+ # @option params [required, String] :workspace_id
1450
+ # The ID of the workspace where you are updating the rule groups
1451
+ # namespace.
1452
+ #
1302
1453
  # @return [Types::PutRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1303
1454
  #
1304
- # * {Types::PutRuleGroupsNamespaceResponse#name #name} => String
1305
1455
  # * {Types::PutRuleGroupsNamespaceResponse#arn #arn} => String
1456
+ # * {Types::PutRuleGroupsNamespaceResponse#name #name} => String
1306
1457
  # * {Types::PutRuleGroupsNamespaceResponse#status #status} => Types::RuleGroupsNamespaceStatus
1307
1458
  # * {Types::PutRuleGroupsNamespaceResponse#tags #tags} => Hash&lt;String,String&gt;
1308
1459
  #
1309
1460
  # @example Request syntax with placeholder values
1310
1461
  #
1311
1462
  # resp = client.put_rule_groups_namespace({
1312
- # workspace_id: "WorkspaceId", # required
1313
- # name: "RuleGroupsNamespaceName", # required
1314
- # data: "data", # required
1315
1463
  # client_token: "IdempotencyToken",
1464
+ # data: "data", # required
1465
+ # name: "RuleGroupsNamespaceName", # required
1466
+ # workspace_id: "WorkspaceId", # required
1316
1467
  # })
1317
1468
  #
1318
1469
  # @example Response structure
1319
1470
  #
1320
- # resp.name #=> String
1321
1471
  # resp.arn #=> String
1472
+ # resp.name #=> String
1322
1473
  # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
1323
1474
  # resp.status.status_reason #=> String
1324
1475
  # resp.tags #=> Hash
@@ -1333,13 +1484,22 @@ module Aws::PrometheusService
1333
1484
  req.send_request(options)
1334
1485
  end
1335
1486
 
1336
- # Creates tags for the specified resource.
1487
+ # The `TagResource` operation associates tags with an Amazon Managed
1488
+ # Service for Prometheus resource. The only resources that can be tagged
1489
+ # are workspaces and rule groups namespaces.
1490
+ #
1491
+ # If you specify a new tag key for the resource, this tag is appended to
1492
+ # the list of tags associated with the resource. If you specify a tag
1493
+ # key that is already associated with the resource, the new tag value
1494
+ # that you specify replaces the previous value for that tag.
1337
1495
  #
1338
1496
  # @option params [required, String] :resource_arn
1339
- # The ARN of the resource.
1497
+ # The ARN of the workspace or rule groups namespace to apply tags to.
1340
1498
  #
1341
1499
  # @option params [required, Hash<String,String>] :tags
1342
- # The list of tags assigned to the resource.
1500
+ # The list of tag keys and values to associate with the resource.
1501
+ #
1502
+ # Keys may not begin with `aws:`.
1343
1503
  #
1344
1504
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1345
1505
  #
@@ -1361,13 +1521,15 @@ module Aws::PrometheusService
1361
1521
  req.send_request(options)
1362
1522
  end
1363
1523
 
1364
- # Deletes tags from the specified resource.
1524
+ # Removes the specified tags from an Amazon Managed Service for
1525
+ # Prometheus resource. The only resources that can be tagged are
1526
+ # workspaces and rule groups namespaces.
1365
1527
  #
1366
1528
  # @option params [required, String] :resource_arn
1367
- # The ARN of the resource.
1529
+ # The ARN of the workspace or rule groups namespace.
1368
1530
  #
1369
1531
  # @option params [required, Array<String>] :tag_keys
1370
- # One or more tag keys
1532
+ # The keys of the tags to remove.
1371
1533
  #
1372
1534
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1373
1535
  #
@@ -1387,22 +1549,23 @@ module Aws::PrometheusService
1387
1549
  req.send_request(options)
1388
1550
  end
1389
1551
 
1390
- # Update logging configuration.
1391
- #
1392
- # @option params [required, String] :workspace_id
1393
- # The ID of the workspace to vend logs to.
1394
- #
1395
- # @option params [required, String] :log_group_arn
1396
- # The ARN of the CW log group to which the vended log data will be
1397
- # published.
1552
+ # Updates the log group ARN or the workspace ID of the current logging
1553
+ # configuration.
1398
1554
  #
1399
1555
  # @option params [String] :client_token
1400
- # Optional, unique, case-sensitive, user-provided identifier to ensure
1401
- # the idempotency of the request.
1556
+ # A unique identifier that you can provide to ensure the idempotency of
1557
+ # the request. Case-sensitive.
1402
1558
  #
1403
1559
  # **A suitable default value is auto-generated.** You should normally
1404
1560
  # not need to pass this option.**
1405
1561
  #
1562
+ # @option params [required, String] :log_group_arn
1563
+ # The ARN of the CloudWatch log group to which the vended log data will
1564
+ # be published.
1565
+ #
1566
+ # @option params [required, String] :workspace_id
1567
+ # The ID of the workspace to update the logging configuration for.
1568
+ #
1406
1569
  # @return [Types::UpdateLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1407
1570
  #
1408
1571
  # * {Types::UpdateLoggingConfigurationResponse#status #status} => Types::LoggingConfigurationStatus
@@ -1410,9 +1573,9 @@ module Aws::PrometheusService
1410
1573
  # @example Request syntax with placeholder values
1411
1574
  #
1412
1575
  # resp = client.update_logging_configuration({
1413
- # workspace_id: "WorkspaceId", # required
1414
- # log_group_arn: "LogGroupArn", # required
1415
1576
  # client_token: "IdempotencyToken",
1577
+ # log_group_arn: "LogGroupArn", # required
1578
+ # workspace_id: "WorkspaceId", # required
1416
1579
  # })
1417
1580
  #
1418
1581
  # @example Response structure
@@ -1429,29 +1592,32 @@ module Aws::PrometheusService
1429
1592
  req.send_request(options)
1430
1593
  end
1431
1594
 
1432
- # Updates an AMP workspace alias.
1433
- #
1434
- # @option params [required, String] :workspace_id
1435
- # The ID of the workspace being updated.
1595
+ # Updates the alias of an existing workspace.
1436
1596
  #
1437
1597
  # @option params [String] :alias
1438
- # The new alias of the workspace.
1598
+ # The new alias for the workspace. It does not need to be unique.
1599
+ #
1600
+ # Amazon Managed Service for Prometheus will automatically strip any
1601
+ # blank spaces from the beginning and end of the alias that you specify.
1439
1602
  #
1440
1603
  # @option params [String] :client_token
1441
- # Optional, unique, case-sensitive, user-provided identifier to ensure
1442
- # the idempotency of the request.
1604
+ # A unique identifier that you can provide to ensure the idempotency of
1605
+ # the request. Case-sensitive.
1443
1606
  #
1444
1607
  # **A suitable default value is auto-generated.** You should normally
1445
1608
  # not need to pass this option.**
1446
1609
  #
1610
+ # @option params [required, String] :workspace_id
1611
+ # The ID of the workspace to update.
1612
+ #
1447
1613
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1448
1614
  #
1449
1615
  # @example Request syntax with placeholder values
1450
1616
  #
1451
1617
  # resp = client.update_workspace_alias({
1452
- # workspace_id: "WorkspaceId", # required
1453
1618
  # alias: "WorkspaceAlias",
1454
1619
  # client_token: "IdempotencyToken",
1620
+ # workspace_id: "WorkspaceId", # required
1455
1621
  # })
1456
1622
  #
1457
1623
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateWorkspaceAlias AWS API Documentation
@@ -1476,7 +1642,7 @@ module Aws::PrometheusService
1476
1642
  params: params,
1477
1643
  config: config)
1478
1644
  context[:gem_name] = 'aws-sdk-prometheusservice'
1479
- context[:gem_version] = '1.29.0'
1645
+ context[:gem_version] = '1.30.0'
1480
1646
  Seahorse::Client::Request.new(handlers, context)
1481
1647
  end
1482
1648