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.
474 475 476 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 474 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.
532 533 534 535 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 532 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.
570 571 572 573 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 570 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.
757 758 759 760 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 757 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, lock snapshots, and
execution plans.
846 847 848 849 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 846 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.
938 939 940 941 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 938 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.
980 981 982 983 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 980 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.
1125 1126 1127 1128 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1125 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.
1201 1202 1203 1204 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1201 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.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1273 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.
1343 1344 1345 1346 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1343 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.
1386 1387 1388 1389 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1386 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.
1430 1431 1432 1433 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1430 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.
1470 1471 1472 1473 |
# File 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 1470 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |