Class: Aws::PI::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::PI::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb
Overview
An API client for PI. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::PI::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_performance_analysis_report(params = {}) ⇒ Types::CreatePerformanceAnalysisReportResponse
Creates a new performance analysis report for a specific time period for the DB instance.
-
#delete_performance_analysis_report(params = {}) ⇒ Struct
Deletes a performance analysis report.
-
#describe_dimension_keys(params = {}) ⇒ Types::DescribeDimensionKeysResponse
For a specific time period, retrieve the top
N
dimension keys for a metric. -
#get_dimension_key_details(params = {}) ⇒ Types::GetDimensionKeyDetailsResponse
Get the attributes of the specified dimension group for a DB instance or data source.
-
#get_performance_analysis_report(params = {}) ⇒ Types::GetPerformanceAnalysisReportResponse
Retrieves the report including the report ID, status, time details, and the insights with recommendations.
-
#get_resource_metadata(params = {}) ⇒ Types::GetResourceMetadataResponse
Retrieve the metadata for different features.
-
#get_resource_metrics(params = {}) ⇒ Types::GetResourceMetricsResponse
Retrieve Performance Insights metrics for a set of data sources over a time period.
-
#list_available_resource_dimensions(params = {}) ⇒ Types::ListAvailableResourceDimensionsResponse
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
-
#list_available_resource_metrics(params = {}) ⇒ Types::ListAvailableResourceMetricsResponse
Retrieve metrics of the specified types that can be queried for a specified DB instance.
-
#list_performance_analysis_reports(params = {}) ⇒ Types::ListPerformanceAnalysisReportsResponse
Lists all the analysis reports created for the DB instance.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to the Amazon RDS Performance Insights resource.
-
#untag_resource(params = {}) ⇒ Struct
Deletes the metadata tags from the Amazon RDS Performance Insights resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
453 454 455 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 453 def initialize(*args) super end |
Instance Method Details
#create_performance_analysis_report(params = {}) ⇒ Types::CreatePerformanceAnalysisReportResponse
Creates a new performance analysis report for a specific time period for the DB instance.
511 512 513 514 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 511 def create_performance_analysis_report(params = {}, = {}) req = build_request(:create_performance_analysis_report, params) req.send_request() end |
#delete_performance_analysis_report(params = {}) ⇒ Struct
Deletes a performance analysis report.
549 550 551 552 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 549 def delete_performance_analysis_report(params = {}, = {}) req = build_request(:delete_performance_analysis_report, params) req.send_request() end |
#describe_dimension_keys(params = {}) ⇒ Types::DescribeDimensionKeysResponse
For a specific time period, retrieve the top N
dimension keys for a
metric.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
734 735 736 737 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 734 def describe_dimension_keys(params = {}, = {}) req = build_request(:describe_dimension_keys, params) req.send_request() end |
#get_dimension_key_details(params = {}) ⇒ Types::GetDimensionKeyDetailsResponse
Get the attributes of the specified dimension group for a DB instance
or data source. For example, if you specify a SQL ID,
GetDimensionKeyDetails
retrieves the full text of the dimension
db.sql.statement
associated with this ID. This operation is useful
because GetResourceMetrics
and DescribeDimensionKeys
don't
support retrieval of large SQL statement text.
812 813 814 815 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 812 def get_dimension_key_details(params = {}, = {}) req = build_request(:get_dimension_key_details, params) req.send_request() end |
#get_performance_analysis_report(params = {}) ⇒ Types::GetPerformanceAnalysisReportResponse
Retrieves the report including the report ID, status, time details,
and the insights with recommendations. The report status can be
RUNNING
, SUCCEEDED
, or FAILED
. The insights include the
description
and recommendation
fields.
900 901 902 903 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 900 def get_performance_analysis_report(params = {}, = {}) req = build_request(:get_performance_analysis_report, params) req.send_request() end |
#get_resource_metadata(params = {}) ⇒ Types::GetResourceMetadataResponse
Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.
942 943 944 945 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 942 def (params = {}, = {}) req = build_request(:get_resource_metadata, params) req.send_request() end |
#get_resource_metrics(params = {}) ⇒ Types::GetResourceMetricsResponse
Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide filtering criteria for each group. You must specify an aggregate function for each metric.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1090 1091 1092 1093 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1090 def get_resource_metrics(params = {}, = {}) req = build_request(:get_resource_metrics, params) req.send_request() end |
#list_available_resource_dimensions(params = {}) ⇒ Types::ListAvailableResourceDimensionsResponse
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1166 1167 1168 1169 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1166 def list_available_resource_dimensions(params = {}, = {}) req = build_request(:list_available_resource_dimensions, params) req.send_request() end |
#list_available_resource_metrics(params = {}) ⇒ Types::ListAvailableResourceMetricsResponse
Retrieve metrics of the specified types that can be queried for a specified DB instance.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1238 1239 1240 1241 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1238 def list_available_resource_metrics(params = {}, = {}) req = build_request(:list_available_resource_metrics, params) req.send_request() end |
#list_performance_analysis_reports(params = {}) ⇒ Types::ListPerformanceAnalysisReportsResponse
Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1308 1309 1310 1311 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1308 def list_performance_analysis_reports(params = {}, = {}) req = build_request(:list_performance_analysis_reports, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.
1351 1352 1353 1354 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1351 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds metadata tags to the Amazon RDS Performance Insights resource.
1395 1396 1397 1398 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1395 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes the metadata tags from the Amazon RDS Performance Insights resource.
1435 1436 1437 1438 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1435 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |