aws-sdk-prometheusservice 1.29.0 → 1.31.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
22
  require 'aws-sdk-core/plugins/response_paging.rb'
23
23
  require 'aws-sdk-core/plugins/stub_responses.rb'
24
24
  require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
25
26
  require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
27
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
28
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -72,6 +73,7 @@ module Aws::PrometheusService
72
73
  add_plugin(Aws::Plugins::ResponsePaging)
73
74
  add_plugin(Aws::Plugins::StubResponses)
74
75
  add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
75
77
  add_plugin(Aws::Plugins::JsonvalueConverter)
76
78
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
79
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -196,10 +198,17 @@ module Aws::PrometheusService
196
198
  # When set to 'true' the request body will not be compressed
197
199
  # for supported operations.
198
200
  #
199
- # @option options [String] :endpoint
200
- # The client endpoint is normally constructed from the `:region`
201
- # option. You should only configure an `:endpoint` when connecting
202
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
201
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
202
+ # Normally you should not configure the `:endpoint` option
203
+ # directly. This is normally constructed from the `:region`
204
+ # option. Configuring `:endpoint` is normally reserved for
205
+ # connecting to test or custom endpoints. The endpoint should
206
+ # be a URI formatted like:
207
+ #
208
+ # 'http://example.com'
209
+ # 'https://example.com'
210
+ # 'http://example.com:123'
211
+ #
203
212
  #
204
213
  # @option options [Integer] :endpoint_cache_max_entries (1000)
205
214
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -337,50 +346,65 @@ module Aws::PrometheusService
337
346
  # @option options [Aws::PrometheusService::EndpointProvider] :endpoint_provider
338
347
  # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::PrometheusService::EndpointParameters`
339
348
  #
340
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
341
- # requests through. Formatted like 'http://proxy.com:123'.
342
- #
343
- # @option options [Float] :http_open_timeout (15) The number of
344
- # seconds to wait when opening a HTTP session before raising a
345
- # `Timeout::Error`.
346
- #
347
- # @option options [Float] :http_read_timeout (60) The default
348
- # number of seconds to wait for response data. This value can
349
- # safely be set per-request on the session.
350
- #
351
- # @option options [Float] :http_idle_timeout (5) The number of
352
- # seconds a connection is allowed to sit idle before it is
353
- # considered stale. Stale connections are closed and removed
354
- # from the pool before making a request.
355
- #
356
- # @option options [Float] :http_continue_timeout (1) The number of
357
- # seconds to wait for a 100-continue response before sending the
358
- # request body. This option has no effect unless the request has
359
- # "Expect" header set to "100-continue". Defaults to `nil` which
360
- # disables this behaviour. This value can safely be set per
361
- # request on the session.
362
- #
363
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
364
- # in seconds.
349
+ # @option options [Float] :http_continue_timeout (1)
350
+ # The number of seconds to wait for a 100-continue response before sending the
351
+ # request body. This option has no effect unless the request has "Expect"
352
+ # header set to "100-continue". Defaults to `nil` which disables this
353
+ # behaviour. This value can safely be set per request on the session.
354
+ #
355
+ # @option options [Float] :http_idle_timeout (5)
356
+ # The number of seconds a connection is allowed to sit idle before it
357
+ # is considered stale. Stale connections are closed and removed from the
358
+ # pool before making a request.
359
+ #
360
+ # @option options [Float] :http_open_timeout (15)
361
+ # The default number of seconds to wait for response data.
362
+ # This value can safely be set per-request on the session.
363
+ #
364
+ # @option options [URI::HTTP,String] :http_proxy
365
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
366
+ #
367
+ # @option options [Float] :http_read_timeout (60)
368
+ # The default number of seconds to wait for response data.
369
+ # This value can safely be set per-request on the session.
370
+ #
371
+ # @option options [Boolean] :http_wire_trace (false)
372
+ # When `true`, HTTP debug output will be sent to the `:logger`.
373
+ #
374
+ # @option options [Proc] :on_chunk_received
375
+ # When a Proc object is provided, it will be used as callback when each chunk
376
+ # of the response body is received. It provides three arguments: the chunk,
377
+ # the number of bytes received, and the total number of
378
+ # bytes in the response (or nil if the server did not send a `content-length`).
379
+ #
380
+ # @option options [Proc] :on_chunk_sent
381
+ # When a Proc object is provided, it will be used as callback when each chunk
382
+ # of the request body is sent. It provides three arguments: the chunk,
383
+ # the number of bytes read from the body, and the total number of
384
+ # bytes in the body.
385
+ #
386
+ # @option options [Boolean] :raise_response_errors (true)
387
+ # When `true`, response errors are raised.
388
+ #
389
+ # @option options [String] :ssl_ca_bundle
390
+ # Full path to the SSL certificate authority bundle file that should be used when
391
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
392
+ # `:ssl_ca_directory` the the system default will be used if available.
393
+ #
394
+ # @option options [String] :ssl_ca_directory
395
+ # Full path of the directory that contains the unbundled SSL certificate
396
+ # authority files for verifying peer certificates. If you do
397
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
398
+ # default will be used if available.
365
399
  #
366
- # @option options [Boolean] :http_wire_trace (false) When `true`,
367
- # HTTP debug output will be sent to the `:logger`.
400
+ # @option options [String] :ssl_ca_store
401
+ # Sets the X509::Store to verify peer certificate.
368
402
  #
369
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
370
- # SSL peer certificates are verified when establishing a
371
- # connection.
403
+ # @option options [Float] :ssl_timeout
404
+ # Sets the SSL timeout in seconds
372
405
  #
373
- # @option options [String] :ssl_ca_bundle Full path to the SSL
374
- # certificate authority bundle file that should be used when
375
- # verifying peer certificates. If you do not pass
376
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
377
- # will be used if available.
378
- #
379
- # @option options [String] :ssl_ca_directory Full path of the
380
- # directory that contains the unbundled SSL certificate
381
- # authority files for verifying peer certificates. If you do
382
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
383
- # system default will be used if available.
406
+ # @option options [Boolean] :ssl_verify_peer (true)
407
+ # When `true`, SSL peer certificates are verified when establishing a connection.
384
408
  #
385
409
  def initialize(*args)
386
410
  super
@@ -388,22 +412,32 @@ module Aws::PrometheusService
388
412
 
389
413
  # @!group API Operations
390
414
 
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.
415
+ # The `CreateAlertManagerDefinition` operation creates the alert manager
416
+ # definition in a workspace. If a workspace already has an alert manager
417
+ # definition, don't use this operation to update it. Instead, use
418
+ # `PutAlertManagerDefinition`.
399
419
  #
400
420
  # @option params [String] :client_token
401
- # Optional, unique, case-sensitive, user-provided identifier to ensure
402
- # the idempotency of the request.
421
+ # A unique identifier that you can provide to ensure the idempotency of
422
+ # the request. Case-sensitive.
403
423
  #
404
424
  # **A suitable default value is auto-generated.** You should normally
405
425
  # not need to pass this option.**
406
426
  #
427
+ # @option params [required, String, StringIO, File] :data
428
+ # The alert manager definition to add. A base64-encoded version of the
429
+ # YAML alert manager definition file.
430
+ #
431
+ # For details about the alert manager definition, see
432
+ # [AlertManagedDefinitionData][1].
433
+ #
434
+ #
435
+ #
436
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html
437
+ #
438
+ # @option params [required, String] :workspace_id
439
+ # The ID of the workspace to add the alert manager definition to.
440
+ #
407
441
  # @return [Types::CreateAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
408
442
  #
409
443
  # * {Types::CreateAlertManagerDefinitionResponse#status #status} => Types::AlertManagerDefinitionStatus
@@ -411,9 +445,9 @@ module Aws::PrometheusService
411
445
  # @example Request syntax with placeholder values
412
446
  #
413
447
  # resp = client.create_alert_manager_definition({
414
- # workspace_id: "WorkspaceId", # required
415
- # data: "data", # required
416
448
  # client_token: "IdempotencyToken",
449
+ # data: "data", # required
450
+ # workspace_id: "WorkspaceId", # required
417
451
  # })
418
452
  #
419
453
  # @example Response structure
@@ -430,22 +464,24 @@ module Aws::PrometheusService
430
464
  req.send_request(options)
431
465
  end
432
466
 
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.
467
+ # The `CreateLoggingConfiguration` operation creates a logging
468
+ # configuration for the workspace. Use this operation to set the
469
+ # CloudWatch log group to which the logs will be published to.
441
470
  #
442
471
  # @option params [String] :client_token
443
- # Optional, unique, case-sensitive, user-provided identifier to ensure
444
- # the idempotency of the request.
472
+ # A unique identifier that you can provide to ensure the idempotency of
473
+ # the request. Case-sensitive.
445
474
  #
446
475
  # **A suitable default value is auto-generated.** You should normally
447
476
  # not need to pass this option.**
448
477
  #
478
+ # @option params [required, String] :log_group_arn
479
+ # The ARN of the CloudWatch log group to which the vended log data will
480
+ # be published. This log group must exist prior to calling this API.
481
+ #
482
+ # @option params [required, String] :workspace_id
483
+ # The ID of the workspace to create the logging configuration for.
484
+ #
449
485
  # @return [Types::CreateLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
450
486
  #
451
487
  # * {Types::CreateLoggingConfigurationResponse#status #status} => Types::LoggingConfigurationStatus
@@ -453,9 +489,9 @@ module Aws::PrometheusService
453
489
  # @example Request syntax with placeholder values
454
490
  #
455
491
  # resp = client.create_logging_configuration({
456
- # workspace_id: "WorkspaceId", # required
457
- # log_group_arn: "LogGroupArn", # required
458
492
  # client_token: "IdempotencyToken",
493
+ # log_group_arn: "LogGroupArn", # required
494
+ # workspace_id: "WorkspaceId", # required
459
495
  # })
460
496
  #
461
497
  # @example Response structure
@@ -472,50 +508,67 @@ module Aws::PrometheusService
472
508
  req.send_request(options)
473
509
  end
474
510
 
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.
511
+ # The `CreateRuleGroupsNamespace` operation creates a rule groups
512
+ # namespace within a workspace. A rule groups namespace is associated
513
+ # with exactly one rules file. A workspace can have multiple rule groups
514
+ # namespaces.
479
515
  #
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.
516
+ # Use this operation only to create new rule groups namespaces. To
517
+ # update an existing rule groups namespace, use
518
+ # `PutRuleGroupsNamespace`.
485
519
  #
486
520
  # @option params [String] :client_token
487
- # Optional, unique, case-sensitive, user-provided identifier to ensure
488
- # the idempotency of the request.
521
+ # A unique identifier that you can provide to ensure the idempotency of
522
+ # the request. Case-sensitive.
489
523
  #
490
524
  # **A suitable default value is auto-generated.** You should normally
491
525
  # not need to pass this option.**
492
526
  #
527
+ # @option params [required, String, StringIO, File] :data
528
+ # The rules file to use in the new namespace.
529
+ #
530
+ # Contains the base64-encoded version of the YAML rules file.
531
+ #
532
+ # For details about the rule groups namespace structure, see
533
+ # [RuleGroupsNamespaceData][1].
534
+ #
535
+ #
536
+ #
537
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html
538
+ #
539
+ # @option params [required, String] :name
540
+ # The name for the new rule groups namespace.
541
+ #
493
542
  # @option params [Hash<String,String>] :tags
494
- # Optional, user-provided tags for this rule groups namespace.
543
+ # The list of tag keys and values to associate with the rule groups
544
+ # namespace.
545
+ #
546
+ # @option params [required, String] :workspace_id
547
+ # The ID of the workspace to add the rule groups namespace.
495
548
  #
496
549
  # @return [Types::CreateRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
497
550
  #
498
- # * {Types::CreateRuleGroupsNamespaceResponse#name #name} => String
499
551
  # * {Types::CreateRuleGroupsNamespaceResponse#arn #arn} => String
552
+ # * {Types::CreateRuleGroupsNamespaceResponse#name #name} => String
500
553
  # * {Types::CreateRuleGroupsNamespaceResponse#status #status} => Types::RuleGroupsNamespaceStatus
501
554
  # * {Types::CreateRuleGroupsNamespaceResponse#tags #tags} => Hash&lt;String,String&gt;
502
555
  #
503
556
  # @example Request syntax with placeholder values
504
557
  #
505
558
  # resp = client.create_rule_groups_namespace({
506
- # workspace_id: "WorkspaceId", # required
507
- # name: "RuleGroupsNamespaceName", # required
508
- # data: "data", # required
509
559
  # client_token: "IdempotencyToken",
560
+ # data: "data", # required
561
+ # name: "RuleGroupsNamespaceName", # required
510
562
  # tags: {
511
563
  # "TagKey" => "TagValue",
512
564
  # },
565
+ # workspace_id: "WorkspaceId", # required
513
566
  # })
514
567
  #
515
568
  # @example Response structure
516
569
  #
517
- # resp.name #=> String
518
570
  # resp.arn #=> String
571
+ # resp.name #=> String
519
572
  # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
520
573
  # resp.status.status_reason #=> String
521
574
  # resp.tags #=> Hash
@@ -530,36 +583,68 @@ module Aws::PrometheusService
530
583
  req.send_request(options)
531
584
  end
532
585
 
533
- # Create a scraper.
586
+ # The `CreateScraper` operation creates a scraper to collect metrics. A
587
+ # scraper pulls metrics from Prometheus-compatible sources within an
588
+ # Amazon EKS cluster, and sends them to your Amazon Managed Service for
589
+ # Prometheus workspace. You can configure the scraper to control what
590
+ # metrics are collected, and what transformations are applied prior to
591
+ # sending them to your workspace.
534
592
  #
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.
593
+ # If needed, an IAM role will be created for you that gives Amazon
594
+ # Managed Service for Prometheus access to the metrics in your cluster.
595
+ # For more information, see [Using roles for scraping metrics from
596
+ # EKS][1] in the *Amazon Managed Service for Prometheus User Guide*.
538
597
  #
539
- # @option params [required, Types::ScrapeConfiguration] :scrape_configuration
540
- # The configuration used to create the scraper.
598
+ # You cannot update a scraper. If you want to change the configuration
599
+ # of the scraper, create a new scraper and delete the old one.
600
+ #
601
+ # The `scrapeConfiguration` parameter contains the base64-encoded
602
+ # version of the YAML configuration file.
603
+ #
604
+ # <note markdown="1"> For more information about collectors, including what metrics are
605
+ # collected, and how to configure the scraper, see [Amazon Web Services
606
+ # managed collectors][2] in the *Amazon Managed Service for Prometheus
607
+ # User Guide*.
608
+ #
609
+ # </note>
541
610
  #
542
- # @option params [required, Types::Source] :source
543
- # The source that the scraper will be discovering and collecting metrics
544
- # from.
545
611
  #
546
- # @option params [required, Types::Destination] :destination
547
- # The destination that the scraper will be producing metrics to.
612
+ #
613
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper
614
+ # [2]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html
615
+ #
616
+ # @option params [String] :alias
617
+ # (optional) a name to associate with the scraper. This is for your use,
618
+ # and does not need to be unique.
548
619
  #
549
620
  # @option params [String] :client_token
550
- # Optional, unique, case-sensitive, user-provided identifier to ensure
551
- # the idempotency of the request.
621
+ # (Optional) A unique, case-sensitive identifier that you can provide to
622
+ # ensure the idempotency of the request.
552
623
  #
553
624
  # **A suitable default value is auto-generated.** You should normally
554
625
  # not need to pass this option.**
555
626
  #
627
+ # @option params [required, Types::Destination] :destination
628
+ # The Amazon Managed Service for Prometheus workspace to send metrics
629
+ # to.
630
+ #
631
+ # @option params [required, Types::ScrapeConfiguration] :scrape_configuration
632
+ # The configuration file to use in the new scraper. For more
633
+ # information, see [Scraper
634
+ # configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
635
+ # in the *Amazon Managed Service for Prometheus User Guide*.
636
+ #
637
+ # @option params [required, Types::Source] :source
638
+ # The Amazon EKS cluster from which the scraper will collect metrics.
639
+ #
556
640
  # @option params [Hash<String,String>] :tags
557
- # Optional, user-provided tags for this scraper.
641
+ # (Optional) The list of tag keys and values to associate with the
642
+ # scraper.
558
643
  #
559
644
  # @return [Types::CreateScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
560
645
  #
561
- # * {Types::CreateScraperResponse#scraper_id #scraper_id} => String
562
646
  # * {Types::CreateScraperResponse#arn #arn} => String
647
+ # * {Types::CreateScraperResponse#scraper_id #scraper_id} => String
563
648
  # * {Types::CreateScraperResponse#status #status} => Types::ScraperStatus
564
649
  # * {Types::CreateScraperResponse#tags #tags} => Hash&lt;String,String&gt;
565
650
  #
@@ -567,6 +652,12 @@ module Aws::PrometheusService
567
652
  #
568
653
  # resp = client.create_scraper({
569
654
  # alias: "ScraperAlias",
655
+ # client_token: "IdempotencyToken",
656
+ # destination: { # required
657
+ # amp_configuration: {
658
+ # workspace_arn: "WorkspaceArn", # required
659
+ # },
660
+ # },
570
661
  # scrape_configuration: { # required
571
662
  # configuration_blob: "data",
572
663
  # },
@@ -577,12 +668,6 @@ module Aws::PrometheusService
577
668
  # subnet_ids: ["SubnetId"], # required
578
669
  # },
579
670
  # },
580
- # destination: { # required
581
- # amp_configuration: {
582
- # workspace_arn: "WorkspaceArn", # required
583
- # },
584
- # },
585
- # client_token: "IdempotencyToken",
586
671
  # tags: {
587
672
  # "TagKey" => "TagValue",
588
673
  # },
@@ -590,8 +675,8 @@ module Aws::PrometheusService
590
675
  #
591
676
  # @example Response structure
592
677
  #
593
- # resp.scraper_id #=> String
594
678
  # resp.arn #=> String
679
+ # resp.scraper_id #=> String
595
680
  # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
596
681
  # resp.tags #=> Hash
597
682
  # resp.tags["TagKey"] #=> String
@@ -605,53 +690,64 @@ module Aws::PrometheusService
605
690
  req.send_request(options)
606
691
  end
607
692
 
608
- # Creates a new AMP workspace.
693
+ # Creates a Prometheus workspace. A workspace is a logical space
694
+ # dedicated to the storage and querying of Prometheus metrics. You can
695
+ # have one or more workspaces in each Region in your account.
609
696
  #
610
697
  # @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.
698
+ # An alias that you assign to this workspace to help you identify it. It
699
+ # does not need to be unique.
700
+ #
701
+ # Blank spaces at the beginning or end of the alias that you specify
702
+ # will be trimmed from the value used.
613
703
  #
614
704
  # @option params [String] :client_token
615
- # Optional, unique, case-sensitive, user-provided identifier to ensure
616
- # the idempotency of the request.
705
+ # A unique identifier that you can provide to ensure the idempotency of
706
+ # the request. Case-sensitive.
617
707
  #
618
708
  # **A suitable default value is auto-generated.** You should normally
619
709
  # not need to pass this option.**
620
710
  #
621
- # @option params [Hash<String,String>] :tags
622
- # Optional, user-provided tags for this workspace.
623
- #
624
711
  # @option params [String] :kms_key_arn
625
- # Optional, customer managed KMS key used to encrypt data for this
626
- # workspace
712
+ # (optional) The ARN for a customer managed KMS key to use for
713
+ # encrypting data within your workspace. For more information about
714
+ # using your own key in your workspace, see [Encryption at rest][1] in
715
+ # the *Amazon Managed Service for Prometheus User Guide*.
716
+ #
717
+ #
718
+ #
719
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html
720
+ #
721
+ # @option params [Hash<String,String>] :tags
722
+ # The list of tag keys and values to associate with the workspace.
627
723
  #
628
724
  # @return [Types::CreateWorkspaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
629
725
  #
630
- # * {Types::CreateWorkspaceResponse#workspace_id #workspace_id} => String
631
726
  # * {Types::CreateWorkspaceResponse#arn #arn} => String
727
+ # * {Types::CreateWorkspaceResponse#kms_key_arn #kms_key_arn} => String
632
728
  # * {Types::CreateWorkspaceResponse#status #status} => Types::WorkspaceStatus
633
729
  # * {Types::CreateWorkspaceResponse#tags #tags} => Hash&lt;String,String&gt;
634
- # * {Types::CreateWorkspaceResponse#kms_key_arn #kms_key_arn} => String
730
+ # * {Types::CreateWorkspaceResponse#workspace_id #workspace_id} => String
635
731
  #
636
732
  # @example Request syntax with placeholder values
637
733
  #
638
734
  # resp = client.create_workspace({
639
735
  # alias: "WorkspaceAlias",
640
736
  # client_token: "IdempotencyToken",
737
+ # kms_key_arn: "KmsKeyArn",
641
738
  # tags: {
642
739
  # "TagKey" => "TagValue",
643
740
  # },
644
- # kms_key_arn: "KmsKeyArn",
645
741
  # })
646
742
  #
647
743
  # @example Response structure
648
744
  #
649
- # resp.workspace_id #=> String
650
745
  # resp.arn #=> String
746
+ # resp.kms_key_arn #=> String
651
747
  # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
652
748
  # resp.tags #=> Hash
653
749
  # resp.tags["TagKey"] #=> String
654
- # resp.kms_key_arn #=> String
750
+ # resp.workspace_id #=> String
655
751
  #
656
752
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/CreateWorkspace AWS API Documentation
657
753
  #
@@ -662,26 +758,25 @@ module Aws::PrometheusService
662
758
  req.send_request(options)
663
759
  end
664
760
 
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.
761
+ # Deletes the alert manager definition from a workspace.
670
762
  #
671
763
  # @option params [String] :client_token
672
- # Optional, unique, case-sensitive, user-provided identifier to ensure
673
- # the idempotency of the request.
764
+ # A unique identifier that you can provide to ensure the idempotency of
765
+ # the request. Case-sensitive.
674
766
  #
675
767
  # **A suitable default value is auto-generated.** You should normally
676
768
  # not need to pass this option.**
677
769
  #
770
+ # @option params [required, String] :workspace_id
771
+ # The ID of the workspace to delete the alert manager definition from.
772
+ #
678
773
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
679
774
  #
680
775
  # @example Request syntax with placeholder values
681
776
  #
682
777
  # resp = client.delete_alert_manager_definition({
683
- # workspace_id: "WorkspaceId", # required
684
778
  # client_token: "IdempotencyToken",
779
+ # workspace_id: "WorkspaceId", # required
685
780
  # })
686
781
  #
687
782
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteAlertManagerDefinition AWS API Documentation
@@ -693,25 +788,26 @@ module Aws::PrometheusService
693
788
  req.send_request(options)
694
789
  end
695
790
 
696
- # Delete logging configuration.
697
- #
698
- # @option params [required, String] :workspace_id
699
- # The ID of the workspace to vend logs to.
791
+ # Deletes the logging configuration for a workspace.
700
792
  #
701
793
  # @option params [String] :client_token
702
- # Optional, unique, case-sensitive, user-provided identifier to ensure
703
- # the idempotency of the request.
794
+ # A unique identifier that you can provide to ensure the idempotency of
795
+ # the request. Case-sensitive.
704
796
  #
705
797
  # **A suitable default value is auto-generated.** You should normally
706
798
  # not need to pass this option.**
707
799
  #
800
+ # @option params [required, String] :workspace_id
801
+ # The ID of the workspace containing the logging configuration to
802
+ # delete.
803
+ #
708
804
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
709
805
  #
710
806
  # @example Request syntax with placeholder values
711
807
  #
712
808
  # resp = client.delete_logging_configuration({
713
- # workspace_id: "WorkspaceId", # required
714
809
  # client_token: "IdempotencyToken",
810
+ # workspace_id: "WorkspaceId", # required
715
811
  # })
716
812
  #
717
813
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteLoggingConfiguration AWS API Documentation
@@ -723,29 +819,31 @@ module Aws::PrometheusService
723
819
  req.send_request(options)
724
820
  end
725
821
 
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.
822
+ # Deletes one rule groups namespace and its associated rule groups
823
+ # definition.
733
824
  #
734
825
  # @option params [String] :client_token
735
- # Optional, unique, case-sensitive, user-provided identifier to ensure
736
- # the idempotency of the request.
826
+ # A unique identifier that you can provide to ensure the idempotency of
827
+ # the request. Case-sensitive.
737
828
  #
738
829
  # **A suitable default value is auto-generated.** You should normally
739
830
  # not need to pass this option.**
740
831
  #
832
+ # @option params [required, String] :name
833
+ # The name of the rule groups namespace to delete.
834
+ #
835
+ # @option params [required, String] :workspace_id
836
+ # The ID of the workspace containing the rule groups namespace and
837
+ # definition to delete.
838
+ #
741
839
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
742
840
  #
743
841
  # @example Request syntax with placeholder values
744
842
  #
745
843
  # resp = client.delete_rule_groups_namespace({
746
- # workspace_id: "WorkspaceId", # required
747
- # name: "RuleGroupsNamespaceName", # required
748
844
  # client_token: "IdempotencyToken",
845
+ # name: "RuleGroupsNamespaceName", # required
846
+ # workspace_id: "WorkspaceId", # required
749
847
  # })
750
848
  #
751
849
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteRuleGroupsNamespace AWS API Documentation
@@ -757,18 +855,19 @@ module Aws::PrometheusService
757
855
  req.send_request(options)
758
856
  end
759
857
 
760
- # Deletes a scraper.
761
- #
762
- # @option params [required, String] :scraper_id
763
- # The ID of the scraper to delete.
858
+ # The `DeleteScraper` operation deletes one scraper, and stops any
859
+ # metrics collection that the scraper performs.
764
860
  #
765
861
  # @option params [String] :client_token
766
- # Optional, unique, case-sensitive, user-provided identifier to ensure
767
- # the idempotency of the request.
862
+ # (Optional) A unique, case-sensitive identifier that you can provide to
863
+ # ensure the idempotency of the request.
768
864
  #
769
865
  # **A suitable default value is auto-generated.** You should normally
770
866
  # not need to pass this option.**
771
867
  #
868
+ # @option params [required, String] :scraper_id
869
+ # The ID of the scraper to delete.
870
+ #
772
871
  # @return [Types::DeleteScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
773
872
  #
774
873
  # * {Types::DeleteScraperResponse#scraper_id #scraper_id} => String
@@ -777,8 +876,8 @@ module Aws::PrometheusService
777
876
  # @example Request syntax with placeholder values
778
877
  #
779
878
  # resp = client.delete_scraper({
780
- # scraper_id: "ScraperId", # required
781
879
  # client_token: "IdempotencyToken",
880
+ # scraper_id: "ScraperId", # required
782
881
  # })
783
882
  #
784
883
  # @example Response structure
@@ -795,25 +894,31 @@ module Aws::PrometheusService
795
894
  req.send_request(options)
796
895
  end
797
896
 
798
- # Deletes an AMP workspace.
897
+ # Deletes an existing workspace.
799
898
  #
800
- # @option params [required, String] :workspace_id
801
- # The ID of the workspace to delete.
899
+ # <note markdown="1"> When you delete a workspace, the data that has been ingested into it
900
+ # is not immediately deleted. It will be permanently deleted within one
901
+ # month.
902
+ #
903
+ # </note>
802
904
  #
803
905
  # @option params [String] :client_token
804
- # Optional, unique, case-sensitive, user-provided identifier to ensure
805
- # the idempotency of the request.
906
+ # A unique identifier that you can provide to ensure the idempotency of
907
+ # the request. Case-sensitive.
806
908
  #
807
909
  # **A suitable default value is auto-generated.** You should normally
808
910
  # not need to pass this option.**
809
911
  #
912
+ # @option params [required, String] :workspace_id
913
+ # The ID of the workspace to delete.
914
+ #
810
915
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
811
916
  #
812
917
  # @example Request syntax with placeholder values
813
918
  #
814
919
  # resp = client.delete_workspace({
815
- # workspace_id: "WorkspaceId", # required
816
920
  # client_token: "IdempotencyToken",
921
+ # workspace_id: "WorkspaceId", # required
817
922
  # })
818
923
  #
819
924
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteWorkspace AWS API Documentation
@@ -825,10 +930,11 @@ module Aws::PrometheusService
825
930
  req.send_request(options)
826
931
  end
827
932
 
828
- # Describes an alert manager definition.
933
+ # Retrieves the full information about the alert manager definition for
934
+ # a workspace.
829
935
  #
830
936
  # @option params [required, String] :workspace_id
831
- # The ID of the workspace to describe.
937
+ # The ID of the workspace to retrieve the alert manager definition from.
832
938
  #
833
939
  # @return [Types::DescribeAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
834
940
  #
@@ -842,11 +948,11 @@ module Aws::PrometheusService
842
948
  #
843
949
  # @example Response structure
844
950
  #
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
951
  # resp.alert_manager_definition.created_at #=> Time
952
+ # resp.alert_manager_definition.data #=> String
849
953
  # resp.alert_manager_definition.modified_at #=> Time
954
+ # resp.alert_manager_definition.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
955
+ # resp.alert_manager_definition.status.status_reason #=> String
850
956
  #
851
957
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeAlertManagerDefinition AWS API Documentation
852
958
  #
@@ -857,10 +963,11 @@ module Aws::PrometheusService
857
963
  req.send_request(options)
858
964
  end
859
965
 
860
- # Describes logging configuration.
966
+ # Returns complete information about the current logging configuration
967
+ # of the workspace.
861
968
  #
862
969
  # @option params [required, String] :workspace_id
863
- # The ID of the workspace to vend logs to.
970
+ # The ID of the workspace to describe the logging configuration for.
864
971
  #
865
972
  # @return [Types::DescribeLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
866
973
  #
@@ -874,12 +981,12 @@ module Aws::PrometheusService
874
981
  #
875
982
  # @example Response structure
876
983
  #
984
+ # resp.logging_configuration.created_at #=> Time
985
+ # resp.logging_configuration.log_group_arn #=> String
986
+ # resp.logging_configuration.modified_at #=> Time
877
987
  # resp.logging_configuration.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
878
988
  # resp.logging_configuration.status.status_reason #=> String
879
989
  # 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
990
  #
884
991
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DescribeLoggingConfiguration AWS API Documentation
885
992
  #
@@ -890,13 +997,15 @@ module Aws::PrometheusService
890
997
  req.send_request(options)
891
998
  end
892
999
 
893
- # Describe a rule groups namespace.
894
- #
895
- # @option params [required, String] :workspace_id
896
- # The ID of the workspace to describe.
1000
+ # Returns complete information about one rule groups namespace. To
1001
+ # retrieve a list of rule groups namespaces, use
1002
+ # `ListRuleGroupsNamespaces`.
897
1003
  #
898
1004
  # @option params [required, String] :name
899
- # The rule groups namespace.
1005
+ # The name of the rule groups namespace that you want information for.
1006
+ #
1007
+ # @option params [required, String] :workspace_id
1008
+ # The ID of the workspace containing the rule groups namespace.
900
1009
  #
901
1010
  # @return [Types::DescribeRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
902
1011
  #
@@ -905,19 +1014,19 @@ module Aws::PrometheusService
905
1014
  # @example Request syntax with placeholder values
906
1015
  #
907
1016
  # resp = client.describe_rule_groups_namespace({
908
- # workspace_id: "WorkspaceId", # required
909
1017
  # name: "RuleGroupsNamespaceName", # required
1018
+ # workspace_id: "WorkspaceId", # required
910
1019
  # })
911
1020
  #
912
1021
  # @example Response structure
913
1022
  #
914
1023
  # resp.rule_groups_namespace.arn #=> String
1024
+ # resp.rule_groups_namespace.created_at #=> Time
1025
+ # resp.rule_groups_namespace.data #=> String
1026
+ # resp.rule_groups_namespace.modified_at #=> Time
915
1027
  # resp.rule_groups_namespace.name #=> String
916
1028
  # resp.rule_groups_namespace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
917
1029
  # 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
1030
  # resp.rule_groups_namespace.tags #=> Hash
922
1031
  # resp.rule_groups_namespace.tags["TagKey"] #=> String
923
1032
  #
@@ -930,10 +1039,11 @@ module Aws::PrometheusService
930
1039
  req.send_request(options)
931
1040
  end
932
1041
 
933
- # Describe an existing scraper.
1042
+ # The `DescribeScraper` operation displays information about an existing
1043
+ # scraper.
934
1044
  #
935
1045
  # @option params [required, String] :scraper_id
936
- # The IDs of the scraper to describe.
1046
+ # The ID of the scraper to describe.
937
1047
  #
938
1048
  # @return [Types::DescribeScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
939
1049
  #
@@ -948,22 +1058,22 @@ module Aws::PrometheusService
948
1058
  # @example Response structure
949
1059
  #
950
1060
  # resp.scraper.alias #=> String
951
- # resp.scraper.scraper_id #=> String
952
1061
  # 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
1062
  # resp.scraper.created_at #=> Time
1063
+ # resp.scraper.destination.amp_configuration.workspace_arn #=> String
956
1064
  # resp.scraper.last_modified_at #=> Time
957
- # resp.scraper.tags #=> Hash
958
- # resp.scraper.tags["TagKey"] #=> String
959
- # resp.scraper.status_reason #=> String
1065
+ # resp.scraper.role_arn #=> String
960
1066
  # resp.scraper.scrape_configuration.configuration_blob #=> String
1067
+ # resp.scraper.scraper_id #=> String
961
1068
  # resp.scraper.source.eks_configuration.cluster_arn #=> String
962
1069
  # resp.scraper.source.eks_configuration.security_group_ids #=> Array
963
1070
  # resp.scraper.source.eks_configuration.security_group_ids[0] #=> String
964
1071
  # resp.scraper.source.eks_configuration.subnet_ids #=> Array
965
1072
  # resp.scraper.source.eks_configuration.subnet_ids[0] #=> String
966
- # resp.scraper.destination.amp_configuration.workspace_arn #=> String
1073
+ # resp.scraper.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
1074
+ # resp.scraper.status_reason #=> String
1075
+ # resp.scraper.tags #=> Hash
1076
+ # resp.scraper.tags["TagKey"] #=> String
967
1077
  #
968
1078
  #
969
1079
  # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -980,7 +1090,7 @@ module Aws::PrometheusService
980
1090
  req.send_request(options)
981
1091
  end
982
1092
 
983
- # Describes an existing AMP workspace.
1093
+ # Returns information about an existing workspace.
984
1094
  #
985
1095
  # @option params [required, String] :workspace_id
986
1096
  # The ID of the workspace to describe.
@@ -997,15 +1107,15 @@ module Aws::PrometheusService
997
1107
  #
998
1108
  # @example Response structure
999
1109
  #
1000
- # resp.workspace.workspace_id #=> String
1001
1110
  # resp.workspace.alias #=> String
1002
1111
  # 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
1112
  # resp.workspace.created_at #=> Time
1113
+ # resp.workspace.kms_key_arn #=> String
1114
+ # resp.workspace.prometheus_endpoint #=> String
1115
+ # resp.workspace.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
1006
1116
  # resp.workspace.tags #=> Hash
1007
1117
  # resp.workspace.tags["TagKey"] #=> String
1008
- # resp.workspace.kms_key_arn #=> String
1118
+ # resp.workspace.workspace_id #=> String
1009
1119
  #
1010
1120
  #
1011
1121
  # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
@@ -1022,7 +1132,8 @@ module Aws::PrometheusService
1022
1132
  req.send_request(options)
1023
1133
  end
1024
1134
 
1025
- # Gets a default configuration.
1135
+ # The `GetDefaultScraperConfiguration` operation returns the default
1136
+ # scraper configuration used when Amazon EKS creates a scraper for you.
1026
1137
  #
1027
1138
  # @return [Types::GetDefaultScraperConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1028
1139
  #
@@ -1041,51 +1152,57 @@ module Aws::PrometheusService
1041
1152
  req.send_request(options)
1042
1153
  end
1043
1154
 
1044
- # Lists rule groups namespaces.
1155
+ # Returns a list of rule groups namespaces in a workspace.
1045
1156
  #
1046
- # @option params [required, String] :workspace_id
1047
- # The ID of the workspace.
1157
+ # @option params [Integer] :max_results
1158
+ # The maximum number of results to return. The default is 100.
1048
1159
  #
1049
1160
  # @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.
1161
+ # Use this parameter to filter the rule groups namespaces that are
1162
+ # returned. Only the namespaces with names that begin with the value
1163
+ # that you specify are returned.
1052
1164
  #
1053
1165
  # @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.
1166
+ # The token for the next set of items to return. You receive this token
1167
+ # from a previous call, and use it to get the next page of results. The
1168
+ # other parameters must be the same as the initial call.
1057
1169
  #
1058
- # @option params [Integer] :max_results
1059
- # Maximum results to return in response (default=100, maximum=1000).
1170
+ # For example, if your initial request has `maxResults` of 10, and there
1171
+ # are 12 rule groups namespaces to return, then your initial request
1172
+ # will return 10 and a `nextToken`. Using the next token in a subsequent
1173
+ # call will return the remaining 2 namespaces.
1174
+ #
1175
+ # @option params [required, String] :workspace_id
1176
+ # The ID of the workspace containing the rule groups namespaces.
1060
1177
  #
1061
1178
  # @return [Types::ListRuleGroupsNamespacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1062
1179
  #
1063
- # * {Types::ListRuleGroupsNamespacesResponse#rule_groups_namespaces #rule_groups_namespaces} => Array&lt;Types::RuleGroupsNamespaceSummary&gt;
1064
1180
  # * {Types::ListRuleGroupsNamespacesResponse#next_token #next_token} => String
1181
+ # * {Types::ListRuleGroupsNamespacesResponse#rule_groups_namespaces #rule_groups_namespaces} => Array&lt;Types::RuleGroupsNamespaceSummary&gt;
1065
1182
  #
1066
1183
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1067
1184
  #
1068
1185
  # @example Request syntax with placeholder values
1069
1186
  #
1070
1187
  # resp = client.list_rule_groups_namespaces({
1071
- # workspace_id: "WorkspaceId", # required
1188
+ # max_results: 1,
1072
1189
  # name: "RuleGroupsNamespaceName",
1073
1190
  # next_token: "PaginationToken",
1074
- # max_results: 1,
1191
+ # workspace_id: "WorkspaceId", # required
1075
1192
  # })
1076
1193
  #
1077
1194
  # @example Response structure
1078
1195
  #
1196
+ # resp.next_token #=> String
1079
1197
  # resp.rule_groups_namespaces #=> Array
1080
1198
  # resp.rule_groups_namespaces[0].arn #=> String
1199
+ # resp.rule_groups_namespaces[0].created_at #=> Time
1200
+ # resp.rule_groups_namespaces[0].modified_at #=> Time
1081
1201
  # resp.rule_groups_namespaces[0].name #=> String
1082
1202
  # resp.rule_groups_namespaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
1083
1203
  # 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
1204
  # resp.rule_groups_namespaces[0].tags #=> Hash
1087
1205
  # resp.rule_groups_namespaces[0].tags["TagKey"] #=> String
1088
- # resp.next_token #=> String
1089
1206
  #
1090
1207
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListRuleGroupsNamespaces AWS API Documentation
1091
1208
  #
@@ -1096,25 +1213,43 @@ module Aws::PrometheusService
1096
1213
  req.send_request(options)
1097
1214
  end
1098
1215
 
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.
1216
+ # The `ListScrapers` operation lists all of the scrapers in your
1217
+ # account. This includes scrapers being created or deleted. You can
1218
+ # optionally filter the returned list.
1102
1219
  #
1103
1220
  # @option params [Hash<String,Array>] :filters
1104
- # A list of scraper filters.
1221
+ # (Optional) A list of key-value pairs to filter the list of scrapers
1222
+ # returned. Keys include `status`, `sourceArn`, `destinationArn`, and
1223
+ # `alias`.
1105
1224
  #
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.
1225
+ # Filters on the same key are `OR`'d together, and filters on different
1226
+ # keys are `AND`'d together. For example,
1227
+ # `status=ACTIVE&status=CREATING&alias=Test`, will return all scrapers
1228
+ # that have the alias Test, and are either in status ACTIVE or CREATING.
1229
+ #
1230
+ # To find all active scrapers that are sending metrics to a specific
1231
+ # Amazon Managed Service for Prometheus workspace, you would use the ARN
1232
+ # of the workspace in a query:
1233
+ #
1234
+ # `status=ACTIVE&destinationArn=arn:aws:aps:us-east-1:123456789012:workspace/ws-example1-1234-abcd-56ef-123456789012`
1235
+ #
1236
+ # If this is included, it filters the results to only the scrapers that
1237
+ # match the filter.
1110
1238
  #
1111
1239
  # @option params [Integer] :max_results
1112
- # Maximum results to return in response (default=100, maximum=1000).
1240
+ # Optional) The maximum number of scrapers to return in one
1241
+ # `ListScrapers` operation. The range is 1-1000.
1242
+ #
1243
+ # If you omit this parameter, the default of 100 is used.
1244
+ #
1245
+ # @option params [String] :next_token
1246
+ # (Optional) The token for the next set of items to return. (You
1247
+ # received this token from a previous call.)
1113
1248
  #
1114
1249
  # @return [Types::ListScrapersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1115
1250
  #
1116
- # * {Types::ListScrapersResponse#scrapers #scrapers} => Array&lt;Types::ScraperSummary&gt;
1117
1251
  # * {Types::ListScrapersResponse#next_token #next_token} => String
1252
+ # * {Types::ListScrapersResponse#scrapers #scrapers} => Array&lt;Types::ScraperSummary&gt;
1118
1253
  #
1119
1254
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1120
1255
  #
@@ -1124,30 +1259,30 @@ module Aws::PrometheusService
1124
1259
  # filters: {
1125
1260
  # "FilterKey" => ["FilterValue"],
1126
1261
  # },
1127
- # next_token: "PaginationToken",
1128
1262
  # max_results: 1,
1263
+ # next_token: "PaginationToken",
1129
1264
  # })
1130
1265
  #
1131
1266
  # @example Response structure
1132
1267
  #
1268
+ # resp.next_token #=> String
1133
1269
  # resp.scrapers #=> Array
1134
1270
  # resp.scrapers[0].alias #=> String
1135
- # resp.scrapers[0].scraper_id #=> String
1136
1271
  # 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
1272
  # resp.scrapers[0].created_at #=> Time
1273
+ # resp.scrapers[0].destination.amp_configuration.workspace_arn #=> String
1140
1274
  # 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
1275
+ # resp.scrapers[0].role_arn #=> String
1276
+ # resp.scrapers[0].scraper_id #=> String
1144
1277
  # resp.scrapers[0].source.eks_configuration.cluster_arn #=> String
1145
1278
  # resp.scrapers[0].source.eks_configuration.security_group_ids #=> Array
1146
1279
  # resp.scrapers[0].source.eks_configuration.security_group_ids[0] #=> String
1147
1280
  # resp.scrapers[0].source.eks_configuration.subnet_ids #=> Array
1148
1281
  # 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
1282
+ # resp.scrapers[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
1283
+ # resp.scrapers[0].status_reason #=> String
1284
+ # resp.scrapers[0].tags #=> Hash
1285
+ # resp.scrapers[0].tags["TagKey"] #=> String
1151
1286
  #
1152
1287
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListScrapers AWS API Documentation
1153
1288
  #
@@ -1158,10 +1293,14 @@ module Aws::PrometheusService
1158
1293
  req.send_request(options)
1159
1294
  end
1160
1295
 
1161
- # Lists the tags you have assigned to the resource.
1296
+ # The `ListTagsForResource` operation returns the tags that are
1297
+ # associated with an Amazon Managed Service for Prometheus resource.
1298
+ # Currently, the only resources that can be tagged are workspaces and
1299
+ # rule groups namespaces.
1162
1300
  #
1163
1301
  # @option params [required, String] :resource_arn
1164
- # The ARN of the resource.
1302
+ # The ARN of the resource to list tages for. Must be a workspace or rule
1303
+ # groups namespace resource.
1165
1304
  #
1166
1305
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1167
1306
  #
@@ -1187,48 +1326,57 @@ module Aws::PrometheusService
1187
1326
  req.send_request(options)
1188
1327
  end
1189
1328
 
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.
1329
+ # Lists all of the Amazon Managed Service for Prometheus workspaces in
1330
+ # your account. This includes workspaces being created or deleted.
1197
1331
  #
1198
1332
  # @option params [String] :alias
1199
- # Optional filter for workspace alias. Only the workspaces with aliases
1200
- # that begin with this value will be returned.
1333
+ # If this is included, it filters the results to only the workspaces
1334
+ # with names that start with the value that you specify here.
1335
+ #
1336
+ # Amazon Managed Service for Prometheus will automatically strip any
1337
+ # blank spaces from the beginning and end of the alias that you specify.
1201
1338
  #
1202
1339
  # @option params [Integer] :max_results
1203
- # Maximum results to return in response (default=100, maximum=1000).
1340
+ # The maximum number of workspaces to return per request. The default is
1341
+ # 100.
1342
+ #
1343
+ # @option params [String] :next_token
1344
+ # The token for the next set of items to return. You receive this token
1345
+ # from a previous call, and use it to get the next page of results. The
1346
+ # other parameters must be the same as the initial call.
1347
+ #
1348
+ # For example, if your initial request has `maxResults` of 10, and there
1349
+ # are 12 workspaces to return, then your initial request will return 10
1350
+ # and a `nextToken`. Using the next token in a subsequent call will
1351
+ # return the remaining 2 workspaces.
1204
1352
  #
1205
1353
  # @return [Types::ListWorkspacesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1206
1354
  #
1207
- # * {Types::ListWorkspacesResponse#workspaces #workspaces} => Array&lt;Types::WorkspaceSummary&gt;
1208
1355
  # * {Types::ListWorkspacesResponse#next_token #next_token} => String
1356
+ # * {Types::ListWorkspacesResponse#workspaces #workspaces} => Array&lt;Types::WorkspaceSummary&gt;
1209
1357
  #
1210
1358
  # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1211
1359
  #
1212
1360
  # @example Request syntax with placeholder values
1213
1361
  #
1214
1362
  # resp = client.list_workspaces({
1215
- # next_token: "PaginationToken",
1216
1363
  # alias: "WorkspaceAlias",
1217
1364
  # max_results: 1,
1365
+ # next_token: "PaginationToken",
1218
1366
  # })
1219
1367
  #
1220
1368
  # @example Response structure
1221
1369
  #
1370
+ # resp.next_token #=> String
1222
1371
  # resp.workspaces #=> Array
1223
- # resp.workspaces[0].workspace_id #=> String
1224
1372
  # resp.workspaces[0].alias #=> String
1225
1373
  # resp.workspaces[0].arn #=> String
1226
- # resp.workspaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
1227
1374
  # resp.workspaces[0].created_at #=> Time
1375
+ # resp.workspaces[0].kms_key_arn #=> String
1376
+ # resp.workspaces[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED"
1228
1377
  # resp.workspaces[0].tags #=> Hash
1229
1378
  # resp.workspaces[0].tags["TagKey"] #=> String
1230
- # resp.workspaces[0].kms_key_arn #=> String
1231
- # resp.next_token #=> String
1379
+ # resp.workspaces[0].workspace_id #=> String
1232
1380
  #
1233
1381
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListWorkspaces AWS API Documentation
1234
1382
  #
@@ -1239,22 +1387,32 @@ module Aws::PrometheusService
1239
1387
  req.send_request(options)
1240
1388
  end
1241
1389
 
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.
1390
+ # Updates an existing alert manager definition in a workspace. If the
1391
+ # workspace does not already have an alert manager definition, don't
1392
+ # use this operation to create it. Instead, use
1393
+ # `CreateAlertManagerDefinition`.
1250
1394
  #
1251
1395
  # @option params [String] :client_token
1252
- # Optional, unique, case-sensitive, user-provided identifier to ensure
1253
- # the idempotency of the request.
1396
+ # A unique identifier that you can provide to ensure the idempotency of
1397
+ # the request. Case-sensitive.
1254
1398
  #
1255
1399
  # **A suitable default value is auto-generated.** You should normally
1256
1400
  # not need to pass this option.**
1257
1401
  #
1402
+ # @option params [required, String, StringIO, File] :data
1403
+ # The alert manager definition to use. A base64-encoded version of the
1404
+ # YAML alert manager definition file.
1405
+ #
1406
+ # For details about the alert manager definition, see
1407
+ # [AlertManagedDefinitionData][1].
1408
+ #
1409
+ #
1410
+ #
1411
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-AlertManagerDefinitionData.html
1412
+ #
1413
+ # @option params [required, String] :workspace_id
1414
+ # The ID of the workspace to update the alert manager definition in.
1415
+ #
1258
1416
  # @return [Types::PutAlertManagerDefinitionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1259
1417
  #
1260
1418
  # * {Types::PutAlertManagerDefinitionResponse#status #status} => Types::AlertManagerDefinitionStatus
@@ -1262,9 +1420,9 @@ module Aws::PrometheusService
1262
1420
  # @example Request syntax with placeholder values
1263
1421
  #
1264
1422
  # resp = client.put_alert_manager_definition({
1265
- # workspace_id: "WorkspaceId", # required
1266
- # data: "data", # required
1267
1423
  # client_token: "IdempotencyToken",
1424
+ # data: "data", # required
1425
+ # workspace_id: "WorkspaceId", # required
1268
1426
  # })
1269
1427
  #
1270
1428
  # @example Response structure
@@ -1281,44 +1439,61 @@ module Aws::PrometheusService
1281
1439
  req.send_request(options)
1282
1440
  end
1283
1441
 
1284
- # Update a rule groups namespace.
1442
+ # Updates an existing rule groups namespace within a workspace. A rule
1443
+ # groups namespace is associated with exactly one rules file. A
1444
+ # workspace can have multiple rule groups namespaces.
1285
1445
  #
1286
- # @option params [required, String] :workspace_id
1287
- # The ID of the workspace in which to update the rule group namespace.
1446
+ # Use this operation only to update existing rule groups namespaces. To
1447
+ # create a new rule groups namespace, use `CreateRuleGroupsNamespace`.
1288
1448
  #
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.
1449
+ # You can't use this operation to add tags to an existing rule groups
1450
+ # namespace. Instead, use `TagResource`.
1294
1451
  #
1295
1452
  # @option params [String] :client_token
1296
- # Optional, unique, case-sensitive, user-provided identifier to ensure
1297
- # the idempotency of the request.
1453
+ # A unique identifier that you can provide to ensure the idempotency of
1454
+ # the request. Case-sensitive.
1298
1455
  #
1299
1456
  # **A suitable default value is auto-generated.** You should normally
1300
1457
  # not need to pass this option.**
1301
1458
  #
1459
+ # @option params [required, String, StringIO, File] :data
1460
+ # The new rules file to use in the namespace. A base64-encoded version
1461
+ # of the YAML rule groups file.
1462
+ #
1463
+ # For details about the rule groups namespace structure, see
1464
+ # [RuleGroupsNamespaceData][1].
1465
+ #
1466
+ #
1467
+ #
1468
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/APIReference/yaml-RuleGroupsNamespaceData.html
1469
+ #
1470
+ # @option params [required, String] :name
1471
+ # The name of the rule groups namespace that you are updating.
1472
+ #
1473
+ # @option params [required, String] :workspace_id
1474
+ # The ID of the workspace where you are updating the rule groups
1475
+ # namespace.
1476
+ #
1302
1477
  # @return [Types::PutRuleGroupsNamespaceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1303
1478
  #
1304
- # * {Types::PutRuleGroupsNamespaceResponse#name #name} => String
1305
1479
  # * {Types::PutRuleGroupsNamespaceResponse#arn #arn} => String
1480
+ # * {Types::PutRuleGroupsNamespaceResponse#name #name} => String
1306
1481
  # * {Types::PutRuleGroupsNamespaceResponse#status #status} => Types::RuleGroupsNamespaceStatus
1307
1482
  # * {Types::PutRuleGroupsNamespaceResponse#tags #tags} => Hash&lt;String,String&gt;
1308
1483
  #
1309
1484
  # @example Request syntax with placeholder values
1310
1485
  #
1311
1486
  # resp = client.put_rule_groups_namespace({
1312
- # workspace_id: "WorkspaceId", # required
1313
- # name: "RuleGroupsNamespaceName", # required
1314
- # data: "data", # required
1315
1487
  # client_token: "IdempotencyToken",
1488
+ # data: "data", # required
1489
+ # name: "RuleGroupsNamespaceName", # required
1490
+ # workspace_id: "WorkspaceId", # required
1316
1491
  # })
1317
1492
  #
1318
1493
  # @example Response structure
1319
1494
  #
1320
- # resp.name #=> String
1321
1495
  # resp.arn #=> String
1496
+ # resp.name #=> String
1322
1497
  # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "UPDATING", "DELETING", "CREATION_FAILED", "UPDATE_FAILED"
1323
1498
  # resp.status.status_reason #=> String
1324
1499
  # resp.tags #=> Hash
@@ -1333,13 +1508,22 @@ module Aws::PrometheusService
1333
1508
  req.send_request(options)
1334
1509
  end
1335
1510
 
1336
- # Creates tags for the specified resource.
1511
+ # The `TagResource` operation associates tags with an Amazon Managed
1512
+ # Service for Prometheus resource. The only resources that can be tagged
1513
+ # are workspaces and rule groups namespaces.
1514
+ #
1515
+ # If you specify a new tag key for the resource, this tag is appended to
1516
+ # the list of tags associated with the resource. If you specify a tag
1517
+ # key that is already associated with the resource, the new tag value
1518
+ # that you specify replaces the previous value for that tag.
1337
1519
  #
1338
1520
  # @option params [required, String] :resource_arn
1339
- # The ARN of the resource.
1521
+ # The ARN of the workspace or rule groups namespace to apply tags to.
1340
1522
  #
1341
1523
  # @option params [required, Hash<String,String>] :tags
1342
- # The list of tags assigned to the resource.
1524
+ # The list of tag keys and values to associate with the resource.
1525
+ #
1526
+ # Keys may not begin with `aws:`.
1343
1527
  #
1344
1528
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1345
1529
  #
@@ -1361,13 +1545,15 @@ module Aws::PrometheusService
1361
1545
  req.send_request(options)
1362
1546
  end
1363
1547
 
1364
- # Deletes tags from the specified resource.
1548
+ # Removes the specified tags from an Amazon Managed Service for
1549
+ # Prometheus resource. The only resources that can be tagged are
1550
+ # workspaces and rule groups namespaces.
1365
1551
  #
1366
1552
  # @option params [required, String] :resource_arn
1367
- # The ARN of the resource.
1553
+ # The ARN of the workspace or rule groups namespace.
1368
1554
  #
1369
1555
  # @option params [required, Array<String>] :tag_keys
1370
- # One or more tag keys
1556
+ # The keys of the tags to remove.
1371
1557
  #
1372
1558
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1373
1559
  #
@@ -1387,22 +1573,23 @@ module Aws::PrometheusService
1387
1573
  req.send_request(options)
1388
1574
  end
1389
1575
 
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.
1576
+ # Updates the log group ARN or the workspace ID of the current logging
1577
+ # configuration.
1398
1578
  #
1399
1579
  # @option params [String] :client_token
1400
- # Optional, unique, case-sensitive, user-provided identifier to ensure
1401
- # the idempotency of the request.
1580
+ # A unique identifier that you can provide to ensure the idempotency of
1581
+ # the request. Case-sensitive.
1402
1582
  #
1403
1583
  # **A suitable default value is auto-generated.** You should normally
1404
1584
  # not need to pass this option.**
1405
1585
  #
1586
+ # @option params [required, String] :log_group_arn
1587
+ # The ARN of the CloudWatch log group to which the vended log data will
1588
+ # be published.
1589
+ #
1590
+ # @option params [required, String] :workspace_id
1591
+ # The ID of the workspace to update the logging configuration for.
1592
+ #
1406
1593
  # @return [Types::UpdateLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1407
1594
  #
1408
1595
  # * {Types::UpdateLoggingConfigurationResponse#status #status} => Types::LoggingConfigurationStatus
@@ -1410,9 +1597,9 @@ module Aws::PrometheusService
1410
1597
  # @example Request syntax with placeholder values
1411
1598
  #
1412
1599
  # resp = client.update_logging_configuration({
1413
- # workspace_id: "WorkspaceId", # required
1414
- # log_group_arn: "LogGroupArn", # required
1415
1600
  # client_token: "IdempotencyToken",
1601
+ # log_group_arn: "LogGroupArn", # required
1602
+ # workspace_id: "WorkspaceId", # required
1416
1603
  # })
1417
1604
  #
1418
1605
  # @example Response structure
@@ -1429,29 +1616,32 @@ module Aws::PrometheusService
1429
1616
  req.send_request(options)
1430
1617
  end
1431
1618
 
1432
- # Updates an AMP workspace alias.
1433
- #
1434
- # @option params [required, String] :workspace_id
1435
- # The ID of the workspace being updated.
1619
+ # Updates the alias of an existing workspace.
1436
1620
  #
1437
1621
  # @option params [String] :alias
1438
- # The new alias of the workspace.
1622
+ # The new alias for the workspace. It does not need to be unique.
1623
+ #
1624
+ # Amazon Managed Service for Prometheus will automatically strip any
1625
+ # blank spaces from the beginning and end of the alias that you specify.
1439
1626
  #
1440
1627
  # @option params [String] :client_token
1441
- # Optional, unique, case-sensitive, user-provided identifier to ensure
1442
- # the idempotency of the request.
1628
+ # A unique identifier that you can provide to ensure the idempotency of
1629
+ # the request. Case-sensitive.
1443
1630
  #
1444
1631
  # **A suitable default value is auto-generated.** You should normally
1445
1632
  # not need to pass this option.**
1446
1633
  #
1634
+ # @option params [required, String] :workspace_id
1635
+ # The ID of the workspace to update.
1636
+ #
1447
1637
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1448
1638
  #
1449
1639
  # @example Request syntax with placeholder values
1450
1640
  #
1451
1641
  # resp = client.update_workspace_alias({
1452
- # workspace_id: "WorkspaceId", # required
1453
1642
  # alias: "WorkspaceAlias",
1454
1643
  # client_token: "IdempotencyToken",
1644
+ # workspace_id: "WorkspaceId", # required
1455
1645
  # })
1456
1646
  #
1457
1647
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateWorkspaceAlias AWS API Documentation
@@ -1476,7 +1666,7 @@ module Aws::PrometheusService
1476
1666
  params: params,
1477
1667
  config: config)
1478
1668
  context[:gem_name] = 'aws-sdk-prometheusservice'
1479
- context[:gem_version] = '1.29.0'
1669
+ context[:gem_version] = '1.31.0'
1480
1670
  Seahorse::Client::Request.new(handlers, context)
1481
1671
  end
1482
1672