aws-sdk-prometheusservice 1.43.0 → 1.44.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 18ae2a19dd4f200102102e99b630476acfd5b552716dae2d93628e7e6eb8582d
4
- data.tar.gz: 5b445d0b1c6b29e84a1f243e3bd0b2c1e976df2390523ff073b4fdba73fe112a
3
+ metadata.gz: 8929049020ac28c4578c52c6e7452516c31358a68fc218f5ba67a92fef058ee8
4
+ data.tar.gz: bd86945887c0dbfdcc6d49d67e4ee4c7176c2316bb53d6ad4e45392cf9c372e2
5
5
  SHA512:
6
- metadata.gz: 9d88764cb68ef2b5f2bb3813e56a0adf79fdbd4aaff0769e292c66a7d962d1c6f43725e91feb1cfe3bfb81b45282225139188ca66552f97777653e884e159a35
7
- data.tar.gz: a6db4f9cdb016aec986035f32506412a112c6bb468aef9bde3acf22a44c2070fdb0129415c929468e72979f21fdd0b8d474f082ea40838abe459196fe5b53e02
6
+ metadata.gz: bd1b5f7fa89e8851d22aabd5c10f7633823b26d56855821eec8fd8d64c6402c9c95d6162b176036e0be9b53f8ad223da4117faf396c67563b09404ed2310a3d2
7
+ data.tar.gz: bb60f4cb6fe959c104c588bae7cd0c72c99ca9ab6f0053d61e689ea23da9fd8b4f44af6d9c72b69fe6b59677f4547682f37da1be90692b8fd7469830f66a2316
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.44.0 (2024-10-31)
5
+ ------------------
6
+
7
+ * Feature - Added support for UpdateScraper API, to enable updating collector configuration in-place
8
+
4
9
  1.43.0 (2024-10-18)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.43.0
1
+ 1.44.0
@@ -512,7 +512,8 @@ module Aws::PrometheusService
512
512
  #
513
513
  # @option params [required, String] :log_group_arn
514
514
  # The ARN of the CloudWatch log group to which the vended log data will
515
- # be published. This log group must exist prior to calling this API.
515
+ # be published. This log group must exist prior to calling this
516
+ # operation.
516
517
  #
517
518
  # @option params [required, String] :workspace_id
518
519
  # The ID of the workspace to create the logging configuration for.
@@ -621,36 +622,35 @@ module Aws::PrometheusService
621
622
  # The `CreateScraper` operation creates a scraper to collect metrics. A
622
623
  # scraper pulls metrics from Prometheus-compatible sources within an
623
624
  # Amazon EKS cluster, and sends them to your Amazon Managed Service for
624
- # Prometheus workspace. You can configure the scraper to control what
625
- # metrics are collected, and what transformations are applied prior to
626
- # sending them to your workspace.
625
+ # Prometheus workspace. Scrapers are flexible, and can be configured to
626
+ # control what metrics are collected, the frequency of collection, what
627
+ # transformations are applied to the metrics, and more.
627
628
  #
628
- # If needed, an IAM role will be created for you that gives Amazon
629
- # Managed Service for Prometheus access to the metrics in your cluster.
630
- # For more information, see [Using roles for scraping metrics from
631
- # EKS][1] in the *Amazon Managed Service for Prometheus User Guide*.
629
+ # An IAM role will be created for you that Amazon Managed Service for
630
+ # Prometheus uses to access the metrics in your cluster. You must
631
+ # configure this role with a policy that allows it to scrape metrics
632
+ # from your cluster. For more information, see [Configuring your Amazon
633
+ # EKS cluster][1] in the *Amazon Managed Service for Prometheus User
634
+ # Guide*.
632
635
  #
633
- # You cannot update a scraper. If you want to change the configuration
634
- # of the scraper, create a new scraper and delete the old one.
635
- #
636
- # The `scrapeConfiguration` parameter contains the base64-encoded
637
- # version of the YAML configuration file.
636
+ # The `scrapeConfiguration` parameter contains the base-64 encoded YAML
637
+ # configuration for the scraper.
638
638
  #
639
639
  # <note markdown="1"> For more information about collectors, including what metrics are
640
- # collected, and how to configure the scraper, see [Amazon Web Services
641
- # managed collectors][2] in the *Amazon Managed Service for Prometheus
642
- # User Guide*.
640
+ # collected, and how to configure the scraper, see [Using an Amazon Web
641
+ # Services managed collector][2] in the *Amazon Managed Service for
642
+ # Prometheus User Guide*.
643
643
  #
644
644
  # </note>
645
645
  #
646
646
  #
647
647
  #
648
- # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/using-service-linked-roles.html#using-service-linked-roles-prom-scraper
649
- # [2]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector.html
648
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-eks-setup
649
+ # [2]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html
650
650
  #
651
651
  # @option params [String] :alias
652
- # (optional) a name to associate with the scraper. This is for your use,
653
- # and does not need to be unique.
652
+ # (optional) An alias to associate with the scraper. This is for your
653
+ # use, and does not need to be unique.
654
654
  #
655
655
  # @option params [String] :client_token
656
656
  # (Optional) A unique, case-sensitive identifier that you can provide to
@@ -665,9 +665,12 @@ module Aws::PrometheusService
665
665
  #
666
666
  # @option params [required, Types::ScrapeConfiguration] :scrape_configuration
667
667
  # The configuration file to use in the new scraper. For more
668
- # information, see [Scraper
669
- # configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
670
- # in the *Amazon Managed Service for Prometheus User Guide*.
668
+ # information, see [Scraper configuration][1] in the *Amazon Managed
669
+ # Service for Prometheus User Guide*.
670
+ #
671
+ #
672
+ #
673
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration
671
674
  #
672
675
  # @option params [required, Types::Source] :source
673
676
  # The Amazon EKS cluster from which the scraper will collect metrics.
@@ -712,7 +715,7 @@ module Aws::PrometheusService
712
715
  #
713
716
  # resp.arn #=> String
714
717
  # resp.scraper_id #=> String
715
- # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
718
+ # resp.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
716
719
  # resp.tags #=> Hash
717
720
  # resp.tags["TagKey"] #=> String
718
721
  #
@@ -918,7 +921,7 @@ module Aws::PrometheusService
918
921
  # @example Response structure
919
922
  #
920
923
  # resp.scraper_id #=> String
921
- # resp.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
924
+ # resp.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
922
925
  #
923
926
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/DeleteScraper AWS API Documentation
924
927
  #
@@ -1105,7 +1108,7 @@ module Aws::PrometheusService
1105
1108
  # resp.scraper.source.eks_configuration.security_group_ids[0] #=> String
1106
1109
  # resp.scraper.source.eks_configuration.subnet_ids #=> Array
1107
1110
  # resp.scraper.source.eks_configuration.subnet_ids[0] #=> String
1108
- # resp.scraper.status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
1111
+ # resp.scraper.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
1109
1112
  # resp.scraper.status_reason #=> String
1110
1113
  # resp.scraper.tags #=> Hash
1111
1114
  # resp.scraper.tags["TagKey"] #=> String
@@ -1314,7 +1317,7 @@ module Aws::PrometheusService
1314
1317
  # resp.scrapers[0].source.eks_configuration.security_group_ids[0] #=> String
1315
1318
  # resp.scrapers[0].source.eks_configuration.subnet_ids #=> Array
1316
1319
  # resp.scrapers[0].source.eks_configuration.subnet_ids[0] #=> String
1317
- # resp.scrapers[0].status.status_code #=> String, one of "CREATING", "ACTIVE", "DELETING", "CREATION_FAILED", "DELETION_FAILED"
1320
+ # resp.scrapers[0].status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
1318
1321
  # resp.scrapers[0].status_reason #=> String
1319
1322
  # resp.scrapers[0].tags #=> Hash
1320
1323
  # resp.scrapers[0].tags["TagKey"] #=> String
@@ -1330,12 +1333,12 @@ module Aws::PrometheusService
1330
1333
 
1331
1334
  # The `ListTagsForResource` operation returns the tags that are
1332
1335
  # associated with an Amazon Managed Service for Prometheus resource.
1333
- # Currently, the only resources that can be tagged are workspaces and
1334
- # rule groups namespaces.
1336
+ # Currently, the only resources that can be tagged are scrapers,
1337
+ # workspaces, and rule groups namespaces.
1335
1338
  #
1336
1339
  # @option params [required, String] :resource_arn
1337
- # The ARN of the resource to list tages for. Must be a workspace or rule
1338
- # groups namespace resource.
1340
+ # The ARN of the resource to list tages for. Must be a workspace,
1341
+ # scraper, or rule groups namespace resource.
1339
1342
  #
1340
1343
  # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1341
1344
  #
@@ -1545,20 +1548,21 @@ module Aws::PrometheusService
1545
1548
 
1546
1549
  # The `TagResource` operation associates tags with an Amazon Managed
1547
1550
  # Service for Prometheus resource. The only resources that can be tagged
1548
- # are workspaces and rule groups namespaces.
1551
+ # are rule groups namespaces, scrapers, and workspaces.
1549
1552
  #
1550
1553
  # If you specify a new tag key for the resource, this tag is appended to
1551
1554
  # the list of tags associated with the resource. If you specify a tag
1552
1555
  # key that is already associated with the resource, the new tag value
1553
- # that you specify replaces the previous value for that tag.
1556
+ # that you specify replaces the previous value for that tag. To remove a
1557
+ # tag, use `UntagResource`.
1554
1558
  #
1555
1559
  # @option params [required, String] :resource_arn
1556
- # The ARN of the workspace or rule groups namespace to apply tags to.
1560
+ # The ARN of the resource to apply tags to.
1557
1561
  #
1558
1562
  # @option params [required, Hash<String,String>] :tags
1559
1563
  # The list of tag keys and values to associate with the resource.
1560
1564
  #
1561
- # Keys may not begin with `aws:`.
1565
+ # Keys must not begin with `aws:`.
1562
1566
  #
1563
1567
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1564
1568
  #
@@ -1581,11 +1585,11 @@ module Aws::PrometheusService
1581
1585
  end
1582
1586
 
1583
1587
  # Removes the specified tags from an Amazon Managed Service for
1584
- # Prometheus resource. The only resources that can be tagged are
1585
- # workspaces and rule groups namespaces.
1588
+ # Prometheus resource. The only resources that can be tagged are rule
1589
+ # groups namespaces, scrapers, and workspaces.
1586
1590
  #
1587
1591
  # @option params [required, String] :resource_arn
1588
- # The ARN of the workspace or rule groups namespace.
1592
+ # The ARN of the resource from which to remove a tag.
1589
1593
  #
1590
1594
  # @option params [required, Array<String>] :tag_keys
1591
1595
  # The keys of the tags to remove.
@@ -1651,6 +1655,82 @@ module Aws::PrometheusService
1651
1655
  req.send_request(options)
1652
1656
  end
1653
1657
 
1658
+ # Updates an existing scraper.
1659
+ #
1660
+ # You can't use this function to update the source from which the
1661
+ # scraper is collecting metrics. To change the source, delete the
1662
+ # scraper and create a new one.
1663
+ #
1664
+ # @option params [String] :alias
1665
+ # The new alias of the scraper.
1666
+ #
1667
+ # @option params [String] :client_token
1668
+ # A unique identifier that you can provide to ensure the idempotency of
1669
+ # the request. Case-sensitive.
1670
+ #
1671
+ # **A suitable default value is auto-generated.** You should normally
1672
+ # not need to pass this option.**
1673
+ #
1674
+ # @option params [Types::Destination] :destination
1675
+ # The new Amazon Managed Service for Prometheus workspace to send
1676
+ # metrics to.
1677
+ #
1678
+ # @option params [Types::ScrapeConfiguration] :scrape_configuration
1679
+ # Contains the base-64 encoded YAML configuration for the scraper.
1680
+ #
1681
+ # <note markdown="1"> For more information about configuring a scraper, see [Using an Amazon
1682
+ # Web Services managed collector][1] in the *Amazon Managed Service for
1683
+ # Prometheus User Guide*.
1684
+ #
1685
+ # </note>
1686
+ #
1687
+ #
1688
+ #
1689
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html
1690
+ #
1691
+ # @option params [required, String] :scraper_id
1692
+ # The ID of the scraper to update.
1693
+ #
1694
+ # @return [Types::UpdateScraperResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1695
+ #
1696
+ # * {Types::UpdateScraperResponse#arn #arn} => String
1697
+ # * {Types::UpdateScraperResponse#scraper_id #scraper_id} => String
1698
+ # * {Types::UpdateScraperResponse#status #status} => Types::ScraperStatus
1699
+ # * {Types::UpdateScraperResponse#tags #tags} => Hash&lt;String,String&gt;
1700
+ #
1701
+ # @example Request syntax with placeholder values
1702
+ #
1703
+ # resp = client.update_scraper({
1704
+ # alias: "ScraperAlias",
1705
+ # client_token: "IdempotencyToken",
1706
+ # destination: {
1707
+ # amp_configuration: {
1708
+ # workspace_arn: "WorkspaceArn", # required
1709
+ # },
1710
+ # },
1711
+ # scrape_configuration: {
1712
+ # configuration_blob: "data",
1713
+ # },
1714
+ # scraper_id: "ScraperId", # required
1715
+ # })
1716
+ #
1717
+ # @example Response structure
1718
+ #
1719
+ # resp.arn #=> String
1720
+ # resp.scraper_id #=> String
1721
+ # resp.status.status_code #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "CREATION_FAILED", "UPDATE_FAILED", "DELETION_FAILED"
1722
+ # resp.tags #=> Hash
1723
+ # resp.tags["TagKey"] #=> String
1724
+ #
1725
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateScraper AWS API Documentation
1726
+ #
1727
+ # @overload update_scraper(params = {})
1728
+ # @param [Hash] params ({})
1729
+ def update_scraper(params = {}, options = {})
1730
+ req = build_request(:update_scraper, params)
1731
+ req.send_request(options)
1732
+ end
1733
+
1654
1734
  # Updates the alias of an existing workspace.
1655
1735
  #
1656
1736
  # @option params [String] :alias
@@ -1706,7 +1786,7 @@ module Aws::PrometheusService
1706
1786
  tracer: tracer
1707
1787
  )
1708
1788
  context[:gem_name] = 'aws-sdk-prometheusservice'
1709
- context[:gem_version] = '1.43.0'
1789
+ context[:gem_version] = '1.44.0'
1710
1790
  Seahorse::Client::Request.new(handlers, context)
1711
1791
  end
1712
1792
 
@@ -120,6 +120,8 @@ module Aws::PrometheusService
120
120
  UntagResourceResponse = Shapes::StructureShape.new(name: 'UntagResourceResponse')
121
121
  UpdateLoggingConfigurationRequest = Shapes::StructureShape.new(name: 'UpdateLoggingConfigurationRequest')
122
122
  UpdateLoggingConfigurationResponse = Shapes::StructureShape.new(name: 'UpdateLoggingConfigurationResponse')
123
+ UpdateScraperRequest = Shapes::StructureShape.new(name: 'UpdateScraperRequest')
124
+ UpdateScraperResponse = Shapes::StructureShape.new(name: 'UpdateScraperResponse')
123
125
  UpdateWorkspaceAliasRequest = Shapes::StructureShape.new(name: 'UpdateWorkspaceAliasRequest')
124
126
  Uri = Shapes::StringShape.new(name: 'Uri')
125
127
  ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
@@ -472,6 +474,19 @@ module Aws::PrometheusService
472
474
  UpdateLoggingConfigurationResponse.add_member(:status, Shapes::ShapeRef.new(shape: LoggingConfigurationStatus, required: true, location_name: "status"))
473
475
  UpdateLoggingConfigurationResponse.struct_class = Types::UpdateLoggingConfigurationResponse
474
476
 
477
+ UpdateScraperRequest.add_member(:alias, Shapes::ShapeRef.new(shape: ScraperAlias, location_name: "alias"))
478
+ UpdateScraperRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
479
+ UpdateScraperRequest.add_member(:destination, Shapes::ShapeRef.new(shape: Destination, location_name: "destination"))
480
+ UpdateScraperRequest.add_member(:scrape_configuration, Shapes::ShapeRef.new(shape: ScrapeConfiguration, location_name: "scrapeConfiguration"))
481
+ UpdateScraperRequest.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location: "uri", location_name: "scraperId"))
482
+ UpdateScraperRequest.struct_class = Types::UpdateScraperRequest
483
+
484
+ UpdateScraperResponse.add_member(:arn, Shapes::ShapeRef.new(shape: ScraperArn, required: true, location_name: "arn"))
485
+ UpdateScraperResponse.add_member(:scraper_id, Shapes::ShapeRef.new(shape: ScraperId, required: true, location_name: "scraperId"))
486
+ UpdateScraperResponse.add_member(:status, Shapes::ShapeRef.new(shape: ScraperStatus, required: true, location_name: "status"))
487
+ UpdateScraperResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "tags"))
488
+ UpdateScraperResponse.struct_class = Types::UpdateScraperResponse
489
+
475
490
  UpdateWorkspaceAliasRequest.add_member(:alias, Shapes::ShapeRef.new(shape: WorkspaceAlias, location_name: "alias"))
476
491
  UpdateWorkspaceAliasRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: IdempotencyToken, location_name: "clientToken", metadata: {"idempotencyToken"=>true}))
477
492
  UpdateWorkspaceAliasRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location: "uri", location_name: "workspaceId"))
@@ -520,9 +535,11 @@ module Aws::PrometheusService
520
535
 
521
536
  api.metadata = {
522
537
  "apiVersion" => "2020-08-01",
538
+ "auth" => ["aws.auth#sigv4"],
523
539
  "endpointPrefix" => "aps",
524
540
  "jsonVersion" => "1.1",
525
541
  "protocol" => "rest-json",
542
+ "protocols" => ["rest-json"],
526
543
  "serviceFullName" => "Amazon Prometheus Service",
527
544
  "serviceId" => "amp",
528
545
  "signatureVersion" => "v4",
@@ -882,6 +899,21 @@ module Aws::PrometheusService
882
899
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
883
900
  end)
884
901
 
902
+ api.add_operation(:update_scraper, Seahorse::Model::Operation.new.tap do |o|
903
+ o.name = "UpdateScraper"
904
+ o.http_method = "PUT"
905
+ o.http_request_uri = "/scrapers/{scraperId}"
906
+ o.input = Shapes::ShapeRef.new(shape: UpdateScraperRequest)
907
+ o.output = Shapes::ShapeRef.new(shape: UpdateScraperResponse)
908
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
909
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
910
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
911
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
912
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
913
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
914
+ o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
915
+ end)
916
+
885
917
  api.add_operation(:update_workspace_alias, Seahorse::Model::Operation.new.tap do |o|
886
918
  o.name = "UpdateWorkspaceAlias"
887
919
  o.http_method = "POST"
@@ -24,7 +24,9 @@ module Aws::PrometheusService
24
24
  include Aws::Structure
25
25
  end
26
26
 
27
- # The details of an alert manager definition.
27
+ # The details of an alert manager definition. It is the configuration
28
+ # for the alert manager, including information about receivers for
29
+ # routing alerts.
28
30
  #
29
31
  # @!attribute [rw] created_at
30
32
  # The date and time that the alert manager definition was created.
@@ -184,7 +186,7 @@ module Aws::PrometheusService
184
186
  # @!attribute [rw] log_group_arn
185
187
  # The ARN of the CloudWatch log group to which the vended log data
186
188
  # will be published. This log group must exist prior to calling this
187
- # API.
189
+ # operation.
188
190
  # @return [String]
189
191
  #
190
192
  # @!attribute [rw] workspace_id
@@ -298,7 +300,7 @@ module Aws::PrometheusService
298
300
  # Represents the input of a `CreateScraper` operation.
299
301
  #
300
302
  # @!attribute [rw] alias
301
- # (optional) a name to associate with the scraper. This is for your
303
+ # (optional) An alias to associate with the scraper. This is for your
302
304
  # use, and does not need to be unique.
303
305
  # @return [String]
304
306
  #
@@ -317,9 +319,12 @@ module Aws::PrometheusService
317
319
  #
318
320
  # @!attribute [rw] scrape_configuration
319
321
  # The configuration file to use in the new scraper. For more
320
- # information, see [Scraper
321
- # configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
322
- # in the *Amazon Managed Service for Prometheus User Guide*.
322
+ # information, see [Scraper configuration][1] in the *Amazon Managed
323
+ # Service for Prometheus User Guide*.
324
+ #
325
+ #
326
+ #
327
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration
323
328
  # @return [Types::ScrapeConfiguration]
324
329
  #
325
330
  # @!attribute [rw] source
@@ -750,7 +755,7 @@ module Aws::PrometheusService
750
755
  # @note Destination is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Destination corresponding to the set member.
751
756
  #
752
757
  # @!attribute [rw] amp_configuration
753
- # The Amazon Managed Service for Prometheusworkspace to send metrics
758
+ # The Amazon Managed Service for Prometheus workspace to send metrics
754
759
  # to.
755
760
  # @return [Types::AmpConfiguration]
756
761
  #
@@ -967,8 +972,8 @@ module Aws::PrometheusService
967
972
  end
968
973
 
969
974
  # @!attribute [rw] resource_arn
970
- # The ARN of the resource to list tages for. Must be a workspace or
971
- # rule groups namespace resource.
975
+ # The ARN of the resource to list tages for. Must be a workspace,
976
+ # scraper, or rule groups namespace resource.
972
977
  # @return [String]
973
978
  #
974
979
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListTagsForResourceRequest AWS API Documentation
@@ -1050,7 +1055,8 @@ module Aws::PrometheusService
1050
1055
  include Aws::Structure
1051
1056
  end
1052
1057
 
1053
- # Contains information about the logging configuration.
1058
+ # Contains information about the logging configuration for the
1059
+ # workspace.
1054
1060
  #
1055
1061
  # @!attribute [rw] created_at
1056
1062
  # The date and time that the logging configuration was created.
@@ -1256,7 +1262,8 @@ module Aws::PrometheusService
1256
1262
  # The details about one rule groups namespace.
1257
1263
  #
1258
1264
  # @!attribute [rw] arn
1259
- # The ARN of the rule groups namespace.
1265
+ # The ARN of the rule groups namespace. For example,
1266
+ # `arn:aws:aps:<region>:123456789012:rulegroupsnamespace/ws-example1-1234-abcd-5678-ef90abcd1234/rulesfile1`.
1260
1267
  # @return [String]
1261
1268
  #
1262
1269
  # @!attribute [rw] created_at
@@ -1369,9 +1376,12 @@ module Aws::PrometheusService
1369
1376
  end
1370
1377
 
1371
1378
  # A scrape configuration for a scraper, base 64 encoded. For more
1372
- # information, see [Scraper
1373
- # configuration](prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration)
1374
- # in the *Amazon Managed Service for Prometheus User Guide*.
1379
+ # information, see [Scraper configuration][1] in the *Amazon Managed
1380
+ # Service for Prometheus User Guide*.
1381
+ #
1382
+ #
1383
+ #
1384
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration
1375
1385
  #
1376
1386
  # @note ScrapeConfiguration is a union - when making an API calls you must set exactly one of the members.
1377
1387
  #
@@ -1402,7 +1412,8 @@ module Aws::PrometheusService
1402
1412
  # @return [String]
1403
1413
  #
1404
1414
  # @!attribute [rw] arn
1405
- # The Amazon Resource Name (ARN) of the scraper.
1415
+ # The Amazon Resource Name (ARN) of the scraper. For example,
1416
+ # `arn:aws:aps:<region>:123456798012:scraper/s-example1-1234-abcd-5678-ef9012abcd34`.
1406
1417
  # @return [String]
1407
1418
  #
1408
1419
  # @!attribute [rw] created_at
@@ -1422,14 +1433,18 @@ module Aws::PrometheusService
1422
1433
  # The Amazon Resource Name (ARN) of the IAM role that provides
1423
1434
  # permissions for the scraper to discover and collect metrics on your
1424
1435
  # behalf.
1436
+ #
1437
+ # For example,
1438
+ # `arn:aws:iam::123456789012:role/service-role/AmazonGrafanaServiceRole-12example`.
1425
1439
  # @return [String]
1426
1440
  #
1427
1441
  # @!attribute [rw] scrape_configuration
1428
- # The configuration file in use by the scraper.
1442
+ # The configuration in use by the scraper.
1429
1443
  # @return [Types::ScrapeConfiguration]
1430
1444
  #
1431
1445
  # @!attribute [rw] scraper_id
1432
- # The ID of the scraper.
1446
+ # The ID of the scraper. For example,
1447
+ # `s-example1-1234-abcd-5678-ef9012abcd34`.
1433
1448
  # @return [String]
1434
1449
  #
1435
1450
  # @!attribute [rw] source
@@ -1610,13 +1625,13 @@ module Aws::PrometheusService
1610
1625
  end
1611
1626
 
1612
1627
  # @!attribute [rw] resource_arn
1613
- # The ARN of the workspace or rule groups namespace to apply tags to.
1628
+ # The ARN of the resource to apply tags to.
1614
1629
  # @return [String]
1615
1630
  #
1616
1631
  # @!attribute [rw] tags
1617
1632
  # The list of tag keys and values to associate with the resource.
1618
1633
  #
1619
- # Keys may not begin with `aws:`.
1634
+ # Keys must not begin with `aws:`.
1620
1635
  # @return [Hash<String,String>]
1621
1636
  #
1622
1637
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/TagResourceRequest AWS API Documentation
@@ -1662,7 +1677,7 @@ module Aws::PrometheusService
1662
1677
  end
1663
1678
 
1664
1679
  # @!attribute [rw] resource_arn
1665
- # The ARN of the workspace or rule groups namespace.
1680
+ # The ARN of the resource from which to remove a tag.
1666
1681
  # @return [String]
1667
1682
  #
1668
1683
  # @!attribute [rw] tag_keys
@@ -1726,6 +1741,81 @@ module Aws::PrometheusService
1726
1741
  include Aws::Structure
1727
1742
  end
1728
1743
 
1744
+ # @!attribute [rw] alias
1745
+ # The new alias of the scraper.
1746
+ # @return [String]
1747
+ #
1748
+ # @!attribute [rw] client_token
1749
+ # A unique identifier that you can provide to ensure the idempotency
1750
+ # of the request. Case-sensitive.
1751
+ #
1752
+ # **A suitable default value is auto-generated.** You should normally
1753
+ # not need to pass this option.
1754
+ # @return [String]
1755
+ #
1756
+ # @!attribute [rw] destination
1757
+ # The new Amazon Managed Service for Prometheus workspace to send
1758
+ # metrics to.
1759
+ # @return [Types::Destination]
1760
+ #
1761
+ # @!attribute [rw] scrape_configuration
1762
+ # Contains the base-64 encoded YAML configuration for the scraper.
1763
+ #
1764
+ # <note markdown="1"> For more information about configuring a scraper, see [Using an
1765
+ # Amazon Web Services managed collector][1] in the *Amazon Managed
1766
+ # Service for Prometheus User Guide*.
1767
+ #
1768
+ # </note>
1769
+ #
1770
+ #
1771
+ #
1772
+ # [1]: https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html
1773
+ # @return [Types::ScrapeConfiguration]
1774
+ #
1775
+ # @!attribute [rw] scraper_id
1776
+ # The ID of the scraper to update.
1777
+ # @return [String]
1778
+ #
1779
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateScraperRequest AWS API Documentation
1780
+ #
1781
+ class UpdateScraperRequest < Struct.new(
1782
+ :alias,
1783
+ :client_token,
1784
+ :destination,
1785
+ :scrape_configuration,
1786
+ :scraper_id)
1787
+ SENSITIVE = []
1788
+ include Aws::Structure
1789
+ end
1790
+
1791
+ # @!attribute [rw] arn
1792
+ # The Amazon Resource Name (ARN) of the updated scraper.
1793
+ # @return [String]
1794
+ #
1795
+ # @!attribute [rw] scraper_id
1796
+ # The ID of the updated scraper.
1797
+ # @return [String]
1798
+ #
1799
+ # @!attribute [rw] status
1800
+ # A structure that displays the current status of the scraper.
1801
+ # @return [Types::ScraperStatus]
1802
+ #
1803
+ # @!attribute [rw] tags
1804
+ # The list of tag keys and values that are associated with the
1805
+ # scraper.
1806
+ # @return [Hash<String,String>]
1807
+ #
1808
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/UpdateScraperResponse AWS API Documentation
1809
+ #
1810
+ class UpdateScraperResponse < Struct.new(
1811
+ :arn,
1812
+ :scraper_id,
1813
+ :status,
1814
+ :tags)
1815
+ SENSITIVE = []
1816
+ include Aws::Structure
1817
+ end
1818
+
1729
1819
  # Represents the input of an `UpdateWorkspaceAlias` operation.
1730
1820
  #
1731
1821
  # @!attribute [rw] alias
@@ -1808,11 +1898,12 @@ module Aws::PrometheusService
1808
1898
  #
1809
1899
  # @!attribute [rw] alias
1810
1900
  # The alias that is assigned to this workspace to help identify it. It
1811
- # may not be unique.
1901
+ # does not need to be unique.
1812
1902
  # @return [String]
1813
1903
  #
1814
1904
  # @!attribute [rw] arn
1815
- # The ARN of the workspace.
1905
+ # The ARN of the workspace. For example,
1906
+ # `arn:aws:aps:<region>:123456789012:workspace/ws-example1-1234-abcd-5678-ef90abcd1234`.
1816
1907
  # @return [String]
1817
1908
  #
1818
1909
  # @!attribute [rw] created_at
@@ -1825,7 +1916,8 @@ module Aws::PrometheusService
1825
1916
  # @return [String]
1826
1917
  #
1827
1918
  # @!attribute [rw] prometheus_endpoint
1828
- # The Prometheus endpoint available for this workspace.
1919
+ # The Prometheus endpoint available for this workspace. For example,
1920
+ # `https://aps-workspaces.<region>.amazonaws.com/workspaces/ws-example1-1234-abcd-5678-ef90abcd1234/api/v1/`.
1829
1921
  # @return [String]
1830
1922
  #
1831
1923
  # @!attribute [rw] status
@@ -1838,7 +1930,8 @@ module Aws::PrometheusService
1838
1930
  # @return [Hash<String,String>]
1839
1931
  #
1840
1932
  # @!attribute [rw] workspace_id
1841
- # The unique ID for the workspace.
1933
+ # The unique ID for the workspace. For example,
1934
+ # `ws-example1-1234-abcd-5678-ef90abcd1234`.
1842
1935
  # @return [String]
1843
1936
  #
1844
1937
  # @see http://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/WorkspaceDescription AWS API Documentation
@@ -1875,7 +1968,7 @@ module Aws::PrometheusService
1875
1968
  #
1876
1969
  # @!attribute [rw] alias
1877
1970
  # The alias that is assigned to this workspace to help identify it. It
1878
- # may not be unique.
1971
+ # does not need to be unique.
1879
1972
  # @return [String]
1880
1973
  #
1881
1974
  # @!attribute [rw] arn
@@ -55,7 +55,7 @@ module Aws::PrometheusService
55
55
  autoload :EndpointProvider, 'aws-sdk-prometheusservice/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-prometheusservice/endpoints'
57
57
 
58
- GEM_VERSION = '1.43.0'
58
+ GEM_VERSION = '1.44.0'
59
59
 
60
60
  end
61
61
 
data/sig/client.rbs CHANGED
@@ -374,6 +374,29 @@ module Aws
374
374
  ) -> _UpdateLoggingConfigurationResponseSuccess
375
375
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateLoggingConfigurationResponseSuccess
376
376
 
377
+ interface _UpdateScraperResponseSuccess
378
+ include ::Seahorse::Client::_ResponseSuccess[Types::UpdateScraperResponse]
379
+ def arn: () -> ::String
380
+ def scraper_id: () -> ::String
381
+ def status: () -> Types::ScraperStatus
382
+ def tags: () -> ::Hash[::String, ::String]
383
+ end
384
+ # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#update_scraper-instance_method
385
+ def update_scraper: (
386
+ ?alias: ::String,
387
+ ?client_token: ::String,
388
+ ?destination: {
389
+ amp_configuration: {
390
+ workspace_arn: ::String
391
+ }?
392
+ },
393
+ ?scrape_configuration: {
394
+ configuration_blob: ::String?
395
+ },
396
+ scraper_id: ::String
397
+ ) -> _UpdateScraperResponseSuccess
398
+ | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateScraperResponseSuccess
399
+
377
400
  # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PrometheusService/Client.html#update_workspace_alias-instance_method
378
401
  def update_workspace_alias: (
379
402
  ?alias: ::String,
data/sig/types.rbs CHANGED
@@ -390,7 +390,7 @@ module Aws::PrometheusService
390
390
  end
391
391
 
392
392
  class ScraperStatus
393
- attr_accessor status_code: ("CREATING" | "ACTIVE" | "DELETING" | "CREATION_FAILED" | "DELETION_FAILED")
393
+ attr_accessor status_code: ("CREATING" | "UPDATING" | "ACTIVE" | "DELETING" | "CREATION_FAILED" | "UPDATE_FAILED" | "DELETION_FAILED")
394
394
  SENSITIVE: []
395
395
  end
396
396
 
@@ -467,6 +467,23 @@ module Aws::PrometheusService
467
467
  SENSITIVE: []
468
468
  end
469
469
 
470
+ class UpdateScraperRequest
471
+ attr_accessor alias: ::String
472
+ attr_accessor client_token: ::String
473
+ attr_accessor destination: Types::Destination
474
+ attr_accessor scrape_configuration: Types::ScrapeConfiguration
475
+ attr_accessor scraper_id: ::String
476
+ SENSITIVE: []
477
+ end
478
+
479
+ class UpdateScraperResponse
480
+ attr_accessor arn: ::String
481
+ attr_accessor scraper_id: ::String
482
+ attr_accessor status: Types::ScraperStatus
483
+ attr_accessor tags: ::Hash[::String, ::String]
484
+ SENSITIVE: []
485
+ end
486
+
470
487
  class UpdateWorkspaceAliasRequest
471
488
  attr_accessor alias: ::String
472
489
  attr_accessor client_token: ::String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-prometheusservice
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.43.0
4
+ version: 1.44.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-10-18 00:00:00.000000000 Z
11
+ date: 2024-10-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -36,14 +36,14 @@ dependencies:
36
36
  requirements:
37
37
  - - "~>"
38
38
  - !ruby/object:Gem::Version
39
- version: '1.1'
39
+ version: '1.5'
40
40
  type: :runtime
41
41
  prerelease: false
42
42
  version_requirements: !ruby/object:Gem::Requirement
43
43
  requirements:
44
44
  - - "~>"
45
45
  - !ruby/object:Gem::Version
46
- version: '1.1'
46
+ version: '1.5'
47
47
  description: Official AWS Ruby gem for Amazon Prometheus Service. This gem is part
48
48
  of the AWS SDK for Ruby.
49
49
  email: