aws-sdk-pi 1.95.0 → 1.96.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 986d440aaaab07463187ac375bd13053ace8a9ce3e4ad0b0495a66be0c1f4d27
-  data.tar.gz: 7118456215b0616902ec7563390d22a48652bce355a014701eb88f08d27b410f
+  metadata.gz: a85783d852526aae217ed51e8a3364ff2ad40381db62e2bc5c631b361caccb2f
+  data.tar.gz: efa31e1ae5ad15da23b6cc45ec513493a9f803e667cbb99bafee7ce371fabde5
 SHA512:
-  metadata.gz: 671a36926e3c71b2160c3a8789b5778a1c7862d49e531347ec52da0a3d8d2bc3156cad215b9def1f3c086acf211c1d9933de115ff12f336bf2a91a4b72b4aabb
-  data.tar.gz: f67fe2e1a339329c4d1c33386af47b393a423db5251aeb745283ce468634269b546b41b3653d15bbad1228097c874fba0ec2b23ff7130a60db8810e9decfeccc
+  metadata.gz: '0783fb1e6701d11eeb4ac38bbcbe0f2e4e3c08abbdf96f8ba5d4dcedb8a843d96c878fd0a9d8e55fe70728434898e134bfacd994c24a7aea9363e753d273be1b'
+  data.tar.gz: acc9cbab1f929039c4496cae348af2b83ea8a8566e1bd99e062de03097f6630703a168fa9f6fd8473431d76079736ffb45be33653a079eacf0e8b0eff28dfedf

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.96.0 (2026-05-22)
+------------------
+
+* Feature - Added ListPerformanceAnalysisReportRecommendations API to retrieve recommendations for a performance analysis report. Added analysis configuration support to CreatePerformanceAnalysisReport for enhanced analysis types such as vacuum analysis.
+
 1.95.0 (2026-05-21)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.95.0
+1.96.0

data/lib/aws-sdk-pi/client.rb

@@ -499,7 +499,7 @@ module Aws::PI
     # @option params [required, Time,DateTime,Date,Integer,String] :start_time
     #   The start time defined for the analysis report.
     #
-    # @option params [required, Time,DateTime,Date,Integer,String] :end_time
+    # @option params [Time,DateTime,Date,Integer,String] :end_time
     #   The end time defined for the analysis report.
     #
     # @option params [Array<Types::Tag>] :tags
@@ -516,7 +516,7 @@ module Aws::PI
     #     service_type: "RDS", # required, accepts RDS, DOCDB
     #     identifier: "IdentifierString", # required
     #     start_time: Time.now, # required
-    #     end_time: Time.now, # required
+    #     end_time: Time.now,
     #     tags: [
     #       {
     #         key: "TagKey", # required
@@ -928,6 +928,7 @@ module Aws::PI
     #   resp.analysis_report.insights[0].recommendations #=> Array
     #   resp.analysis_report.insights[0].recommendations[0].recommendation_id #=> String
     #   resp.analysis_report.insights[0].recommendations[0].recommendation_description #=> String
+    #   resp.analysis_report.insights[0].recommendations[0].recommendation_details #=> String
     #   resp.analysis_report.insights[0].insight_data #=> Array
     #   resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.metric #=> String
     #   resp.analysis_report.insights[0].insight_data[0].performance_insights_metric.display_name #=> String
@@ -1289,6 +1290,75 @@ module Aws::PI
       req.send_request(options)
     end
 
+    # Retrieves recommendations for a performance analysis report.
+    #
+    # @option params [required, String] :service_type
+    #   The Amazon Web Services service for which Performance Insights returns
+    #   metrics. Valid value is `RDS`.
+    #
+    # @option params [required, String] :identifier
+    #   An immutable identifier for a data source that is unique for an Amazon
+    #   Web Services Region. Performance Insights gathers metrics from this
+    #   data source. In the console, the identifier is shown as *ResourceID*.
+    #   When you call `DescribeDBInstances`, the identifier is returned as
+    #   `DbiResourceId`.
+    #
+    #   To use a DB instance as a data source, specify its `DbiResourceId`
+    #   value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
+    #
+    # @option params [required, String] :analysis_report_id
+    #   A unique identifier of the created analysis report. For example,
+    #   `report-12345678901234567`
+    #
+    # @option params [Array<String>] :recommendation_ids
+    #   A list of recommendation identifiers to filter the results.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum number of items to return in the response. If more items
+    #   exist than the specified `MaxResults` value, a pagination token is
+    #   included in the response so that the remaining results can be
+    #   retrieved.
+    #
+    # @option params [String] :next_token
+    #   An optional pagination token provided by a previous request. If this
+    #   parameter is specified, the response includes only records beyond the
+    #   token, up to the value specified by `MaxResults`.
+    #
+    # @return [Types::ListPerformanceAnalysisReportRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListPerformanceAnalysisReportRecommendationsResponse#recommendations #recommendations} => Array&lt;Types::Recommendation&gt;
+    #   * {Types::ListPerformanceAnalysisReportRecommendationsResponse#next_token #next_token} => String
+    #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_performance_analysis_report_recommendations({
+    #     service_type: "RDS", # required, accepts RDS, DOCDB
+    #     identifier: "IdentifierString", # required
+    #     analysis_report_id: "AnalysisReportId", # required
+    #     recommendation_ids: ["String"],
+    #     max_results: 1,
+    #     next_token: "NextToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.recommendations #=> Array
+    #   resp.recommendations[0].recommendation_id #=> String
+    #   resp.recommendations[0].recommendation_description #=> String
+    #   resp.recommendations[0].recommendation_details #=> String
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListPerformanceAnalysisReportRecommendations AWS API Documentation
+    #
+    # @overload list_performance_analysis_report_recommendations(params = {})
+    # @param [Hash] params ({})
+    def list_performance_analysis_report_recommendations(params = {}, options = {})
+      req = build_request(:list_performance_analysis_report_recommendations, params)
+      req.send_request(options)
+    end
+
     # Lists all the analysis reports created for the DB instance. The
     # reports are sorted based on the start time of each report.
     #
@@ -1504,7 +1574,7 @@ module Aws::PI
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-pi'
-      context[:gem_version] = '1.95.0'
+      context[:gem_version] = '1.96.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-pi/client_api.rb

@@ -77,6 +77,8 @@ module Aws::PI
     ListAvailableResourceDimensionsResponse = Shapes::StructureShape.new(name: 'ListAvailableResourceDimensionsResponse')
     ListAvailableResourceMetricsRequest = Shapes::StructureShape.new(name: 'ListAvailableResourceMetricsRequest')
     ListAvailableResourceMetricsResponse = Shapes::StructureShape.new(name: 'ListAvailableResourceMetricsResponse')
+    ListPerformanceAnalysisReportRecommendationsRequest = Shapes::StructureShape.new(name: 'ListPerformanceAnalysisReportRecommendationsRequest')
+    ListPerformanceAnalysisReportRecommendationsResponse = Shapes::StructureShape.new(name: 'ListPerformanceAnalysisReportRecommendationsResponse')
     ListPerformanceAnalysisReportsRequest = Shapes::StructureShape.new(name: 'ListPerformanceAnalysisReportsRequest')
     ListPerformanceAnalysisReportsResponse = Shapes::StructureShape.new(name: 'ListPerformanceAnalysisReportsResponse')
     ListTagsForResourceRequest = Shapes::StructureShape.new(name: 'ListTagsForResourceRequest')
@@ -97,6 +99,7 @@ module Aws::PI
     PerformanceInsightsMetric = Shapes::StructureShape.new(name: 'PerformanceInsightsMetric')
     PeriodAlignment = Shapes::StringShape.new(name: 'PeriodAlignment')
     Recommendation = Shapes::StructureShape.new(name: 'Recommendation')
+    RecommendationIdList = Shapes::ListShape.new(name: 'RecommendationIdList')
     RecommendationList = Shapes::ListShape.new(name: 'RecommendationList')
     RequestString = Shapes::StringShape.new(name: 'RequestString')
     RequestedDimensionList = Shapes::ListShape.new(name: 'RequestedDimensionList')
@@ -151,7 +154,7 @@ module Aws::PI
     CreatePerformanceAnalysisReportRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
     CreatePerformanceAnalysisReportRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: IdentifierString, required: true, location_name: "Identifier"))
     CreatePerformanceAnalysisReportRequest.add_member(:start_time, Shapes::ShapeRef.new(shape: ISOTimestamp, required: true, location_name: "StartTime"))
-    CreatePerformanceAnalysisReportRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: ISOTimestamp, required: true, location_name: "EndTime"))
+    CreatePerformanceAnalysisReportRequest.add_member(:end_time, Shapes::ShapeRef.new(shape: ISOTimestamp, location_name: "EndTime"))
     CreatePerformanceAnalysisReportRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
     CreatePerformanceAnalysisReportRequest.struct_class = Types::CreatePerformanceAnalysisReportRequest
 
@@ -332,6 +335,18 @@ module Aws::PI
     ListAvailableResourceMetricsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
     ListAvailableResourceMetricsResponse.struct_class = Types::ListAvailableResourceMetricsResponse
 
+    ListPerformanceAnalysisReportRecommendationsRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
+    ListPerformanceAnalysisReportRecommendationsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: IdentifierString, required: true, location_name: "Identifier"))
+    ListPerformanceAnalysisReportRecommendationsRequest.add_member(:analysis_report_id, Shapes::ShapeRef.new(shape: AnalysisReportId, required: true, location_name: "AnalysisReportId"))
+    ListPerformanceAnalysisReportRecommendationsRequest.add_member(:recommendation_ids, Shapes::ShapeRef.new(shape: RecommendationIdList, location_name: "RecommendationIds"))
+    ListPerformanceAnalysisReportRecommendationsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
+    ListPerformanceAnalysisReportRecommendationsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListPerformanceAnalysisReportRecommendationsRequest.struct_class = Types::ListPerformanceAnalysisReportRecommendationsRequest
+
+    ListPerformanceAnalysisReportRecommendationsResponse.add_member(:recommendations, Shapes::ShapeRef.new(shape: RecommendationList, location_name: "Recommendations"))
+    ListPerformanceAnalysisReportRecommendationsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
+    ListPerformanceAnalysisReportRecommendationsResponse.struct_class = Types::ListPerformanceAnalysisReportRecommendationsResponse
+
     ListPerformanceAnalysisReportsRequest.add_member(:service_type, Shapes::ShapeRef.new(shape: ServiceType, required: true, location_name: "ServiceType"))
     ListPerformanceAnalysisReportsRequest.add_member(:identifier, Shapes::ShapeRef.new(shape: IdentifierString, required: true, location_name: "Identifier"))
     ListPerformanceAnalysisReportsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
@@ -388,8 +403,11 @@ module Aws::PI
 
     Recommendation.add_member(:recommendation_id, Shapes::ShapeRef.new(shape: String, location_name: "RecommendationId"))
     Recommendation.add_member(:recommendation_description, Shapes::ShapeRef.new(shape: MarkdownString, location_name: "RecommendationDescription"))
+    Recommendation.add_member(:recommendation_details, Shapes::ShapeRef.new(shape: MarkdownString, location_name: "RecommendationDetails"))
     Recommendation.struct_class = Types::Recommendation
 
+    RecommendationIdList.member = Shapes::ShapeRef.new(shape: String)
+
     RecommendationList.member = Shapes::ShapeRef.new(shape: Recommendation)
 
     RequestedDimensionList.member = Shapes::ShapeRef.new(shape: SanitizedString)
@@ -579,6 +597,23 @@ module Aws::PI
         )
       end)
 
+      api.add_operation(:list_performance_analysis_report_recommendations, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "ListPerformanceAnalysisReportRecommendations"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: ListPerformanceAnalysisReportRecommendationsRequest)
+        o.output = Shapes::ShapeRef.new(shape: ListPerformanceAnalysisReportRecommendationsResponse)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidArgumentException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServiceError)
+        o.errors << Shapes::ShapeRef.new(shape: NotAuthorizedException)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_results",
+          tokens: {
+            "next_token" => "next_token"
+          }
+        )
+      end)
+
       api.add_operation(:list_performance_analysis_reports, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListPerformanceAnalysisReports"
         o.http_method = "POST"

data/lib/aws-sdk-pi/types.rb

@@ -1381,6 +1381,76 @@ module Aws::PI
       include Aws::Structure
     end
 
+    # @!attribute [rw] service_type
+    #   The Amazon Web Services service for which Performance Insights
+    #   returns metrics. Valid value is `RDS`.
+    #   @return [String]
+    #
+    # @!attribute [rw] identifier
+    #   An immutable identifier for a data source that is unique for an
+    #   Amazon Web Services Region. Performance Insights gathers metrics
+    #   from this data source. In the console, the identifier is shown as
+    #   *ResourceID*. When you call `DescribeDBInstances`, the identifier is
+    #   returned as `DbiResourceId`.
+    #
+    #   To use a DB instance as a data source, specify its `DbiResourceId`
+    #   value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
+    #   @return [String]
+    #
+    # @!attribute [rw] analysis_report_id
+    #   A unique identifier of the created analysis report. For example,
+    #   `report-12345678901234567`
+    #   @return [String]
+    #
+    # @!attribute [rw] recommendation_ids
+    #   A list of recommendation identifiers to filter the results.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of items to return in the response. If more items
+    #   exist than the specified `MaxResults` value, a pagination token is
+    #   included in the response so that the remaining results can be
+    #   retrieved.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   An optional pagination token provided by a previous request. If this
+    #   parameter is specified, the response includes only records beyond
+    #   the token, up to the value specified by `MaxResults`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListPerformanceAnalysisReportRecommendationsRequest AWS API Documentation
+    #
+    class ListPerformanceAnalysisReportRecommendationsRequest < Struct.new(
+      :service_type,
+      :identifier,
+      :analysis_report_id,
+      :recommendation_ids,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] recommendations
+    #   The list of recommendations for the analysis report.
+    #   @return [Array<Types::Recommendation>]
+    #
+    # @!attribute [rw] next_token
+    #   An optional pagination token provided by a previous request. If this
+    #   parameter is specified, the response includes only records beyond
+    #   the token, up to the value specified by `MaxResults`.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/ListPerformanceAnalysisReportRecommendationsResponse AWS API Documentation
+    #
+    class ListPerformanceAnalysisReportRecommendationsResponse < Struct.new(
+      :recommendations,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] service_type
     #   The Amazon Web Services service for which Performance Insights
     #   returns metrics. Valid value is `RDS`.
@@ -1660,12 +1730,18 @@ module Aws::PI
     #   100% of the total DBLoad during that time period: sql-id`
     #   @return [String]
     #
+    # @!attribute [rw] recommendation_details
+    #   Detailed information about the recommendation, including steps to
+    #   resolve the performance issue.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/Recommendation AWS API Documentation
     #
     class Recommendation < Struct.new(
       :recommendation_id,
-      :recommendation_description)
-      SENSITIVE = [:recommendation_description]
+      :recommendation_description,
+      :recommendation_details)
+      SENSITIVE = [:recommendation_description, :recommendation_details]
       include Aws::Structure
     end
 

data/lib/aws-sdk-pi.rb

@@ -54,7 +54,7 @@ module Aws::PI
   autoload :EndpointProvider, 'aws-sdk-pi/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-pi/endpoints'
 
-  GEM_VERSION = '1.95.0'
+  GEM_VERSION = '1.96.0'
 
 end
 

data/sig/client.rbs

@@ -88,7 +88,7 @@ module Aws
                                                 service_type: ("RDS" | "DOCDB"),
                                                 identifier: ::String,
                                                 start_time: ::Time,
-                                                end_time: ::Time,
+                                                ?end_time: ::Time,
                                                 ?tags: Array[
                                                   {
                                                     key: ::String,
@@ -245,6 +245,22 @@ module Aws
                                            ) -> _ListAvailableResourceMetricsResponseSuccess
                                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListAvailableResourceMetricsResponseSuccess
 
+      interface _ListPerformanceAnalysisReportRecommendationsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListPerformanceAnalysisReportRecommendationsResponse]
+        def recommendations: () -> ::Array[Types::Recommendation]
+        def next_token: () -> ::String
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/PI/Client.html#list_performance_analysis_report_recommendations-instance_method
+      def list_performance_analysis_report_recommendations: (
+                                                              service_type: ("RDS" | "DOCDB"),
+                                                              identifier: ::String,
+                                                              analysis_report_id: ::String,
+                                                              ?recommendation_ids: Array[::String],
+                                                              ?max_results: ::Integer,
+                                                              ?next_token: ::String
+                                                            ) -> _ListPerformanceAnalysisReportRecommendationsResponseSuccess
+                                                          | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListPerformanceAnalysisReportRecommendationsResponseSuccess
+
       interface _ListPerformanceAnalysisReportsResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListPerformanceAnalysisReportsResponse]
         def analysis_reports: () -> ::Array[Types::AnalysisReportSummary]

data/sig/types.rbs

@@ -246,6 +246,22 @@ module Aws::PI
       SENSITIVE: []
     end
 
+    class ListPerformanceAnalysisReportRecommendationsRequest
+      attr_accessor service_type: ("RDS" | "DOCDB")
+      attr_accessor identifier: ::String
+      attr_accessor analysis_report_id: ::String
+      attr_accessor recommendation_ids: ::Array[::String]
+      attr_accessor max_results: ::Integer
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
+    class ListPerformanceAnalysisReportRecommendationsResponse
+      attr_accessor recommendations: ::Array[Types::Recommendation]
+      attr_accessor next_token: ::String
+      SENSITIVE: []
+    end
+
     class ListPerformanceAnalysisReportsRequest
       attr_accessor service_type: ("RDS" | "DOCDB")
       attr_accessor identifier: ::String
@@ -308,7 +324,8 @@ module Aws::PI
     class Recommendation
       attr_accessor recommendation_id: ::String
       attr_accessor recommendation_description: ::String
-      SENSITIVE: [:recommendation_description]
+      attr_accessor recommendation_details: ::String
+      SENSITIVE: [:recommendation_description, :recommendation_details]
     end
 
     class ResponsePartitionKey

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-pi
 version: !ruby/object:Gem::Version
-  version: 1.95.0
+  version: 1.96.0
 platform: ruby
 authors:
 - Amazon Web Services