class Aws::PI::Client
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See {#initialize} for a full list of supported configuration options.
Attributes
@api private
Public Class Methods
@api private
# File lib/aws-sdk-pi/client.rb, line 726 def errors_module Errors end
@overload initialize(options)
@param [Hash] options @option options [required, Aws::CredentialProvider] :credentials Your AWS credentials. This can be an instance of any one of the following classes: * `Aws::Credentials` - Used for configuring static, non-refreshing credentials. * `Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`. * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web. * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`. * `Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout. * `Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance. * `Aws::ECSCredentials` - Used for loading credentials from instances running in ECS. * `Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service. When `:credentials` are not configured directly, the following locations will be searched for credentials: * `Aws.config[:credentials]` * The `:access_key_id`, `:secret_access_key`, and `:session_token` options. * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'] * `~/.aws/credentials` * `~/.aws/config` * EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. @option options [required, String] :region The AWS region to connect to. The configured `:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations: * `Aws.config[:region]` * `ENV['AWS_REGION']` * `ENV['AMAZON_REGION']` * `ENV['AWS_DEFAULT_REGION']` * `~/.aws/credentials` * `~/.aws/config` @option options [String] :access_key_id @option options [Boolean] :active_endpoint_cache (false) When set to `true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`. @option options [Boolean] :adaptive_retry_wait_to_fill (true) Used only in `adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping. @option options [Boolean] :client_side_monitoring (false) When `true`, client-side metrics will be collected for all API requests from this client. @option options [String] :client_side_monitoring_client_id ("") Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string. @option options [String] :client_side_monitoring_host ("127.0.0.1") Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Integer] :client_side_monitoring_port (31000) Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP. @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher. @option options [Boolean] :convert_params (true) When `true`, an attempt is made to coerce request parameters into the required types. @option options [Boolean] :correct_clock_skew (true) Used only in `standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. @option options [Boolean] :disable_host_prefix_injection (false) Set to true to disable SDK automatically adding host prefix to default service endpoint when available. @option options [String] :endpoint The client endpoint is normally constructed from the `:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI. @option options [Integer] :endpoint_cache_max_entries (1000) Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. @option options [Integer] :endpoint_cache_max_threads (10) Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. @option options [Integer] :endpoint_cache_poll_interval (60) When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. @option options [Boolean] :endpoint_discovery (false) When set to `true`, endpoint discovery will be enabled for operations when available. @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) The log formatter. @option options [Symbol] :log_level (:info) The log level to send messages to the `:logger` at. @option options [Logger] :logger The Logger instance to send log messages to. If this option is not set, logging will be disabled. @option options [Integer] :max_attempts (3) An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in `standard` and `adaptive` retry modes. @option options [String] :profile ("default") Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. @option options [Proc] :retry_backoff A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the `legacy` retry mode. @option options [Float] :retry_base_delay (0.3) The base delay in seconds used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [Symbol] :retry_jitter (:none) A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the `legacy` retry mode. @see https://www.awsarchitectureblog.com/2015/03/backoff.html @option options [Integer] :retry_limit (3) The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the `legacy` retry mode. @option options [Integer] :retry_max_delay (0) The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the `legacy` retry mode. @option options [String] :retry_mode ("legacy") Specifies which retry algorithm to use. Values are: * `legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided. * `standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make. * `adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future. @option options [String] :secret_access_key @option options [String] :session_token @option options [Boolean] :simple_json (false) Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures. When `:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. @option options [Boolean] :stub_responses (false) Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling {ClientStubs#stub_responses}. See {ClientStubs} for more information. ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled. @option options [Boolean] :validate_params (true) When `true`, request parameters are validated before sending the request. @option options [URI::HTTP,String] :http_proxy A proxy to send requests through. Formatted like 'http://proxy.com:123'. @option options [Float] :http_open_timeout (15) The number of seconds to wait when opening a HTTP session before raising a `Timeout::Error`. @option options [Integer] :http_read_timeout (60) The default number of seconds to wait for response data. This value can safely be set per-request on the session. @option options [Float] :http_idle_timeout (5) The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request. @option options [Float] :http_continue_timeout (1) The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to `nil` which disables this behaviour. This value can safely be set per request on the session. @option options [Boolean] :http_wire_trace (false) When `true`, HTTP debug output will be sent to the `:logger`. @option options [Boolean] :ssl_verify_peer (true) When `true`, SSL peer certificates are verified when establishing a connection. @option options [String] :ssl_ca_bundle Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available. @option options [String] :ssl_ca_directory Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.
# File lib/aws-sdk-pi/client.rb, line 334 def initialize(*args) super end
Public Instance Methods
@param params ({}) @api private
# File lib/aws-sdk-pi/client.rb, line 701 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-pi' context[:gem_version] = '1.31.0' Seahorse::Client::Request.new(handlers, context) end
For a specific time period, retrieve the top `N` dimension keys for a metric.
<note markdown=“1”> Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
</note>
@option params [required, String] :service_type
The AWS service for which Performance Insights will return metrics. The only valid value for *ServiceType* is `RDS`.
@option params [required, String] :identifier
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use an Amazon RDS instance as a data source, you specify its `DbiResourceId` value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`
@option params [required, Time,DateTime,Date,Integer,String] :start_time
The date and time specifying the beginning of the requested time series data. You must specify a `StartTime` within the past 7 days. The value specified is *inclusive*, which means that data points equal to or greater than `StartTime` are returned. The value for `StartTime` must be earlier than the value for `EndTime`.
@option params [required, Time,DateTime,Date,Integer,String] :end_time
The date and time specifying the end of the requested time series data. The value specified is *exclusive*, which means that data points less than (but not equal to) `EndTime` are returned. The value for `EndTime` must be later than the value for `StartTime`.
@option params [required, String] :metric
The name of a Performance Insights metric to be measured. Valid values for `Metric` are: * `db.load.avg` - a scaled representation of the number of active sessions for the database engine. * `db.sampledload.avg` - the raw number of active sessions for the database engine. If the number of active sessions is less than an internal Performance Insights threshold, `db.load.avg` and `db.sampledload.avg` are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with `db.load.avg` showing the scaled values, `db.sampledload.avg` showing the raw values, and `db.sampledload.avg` less than `db.load.avg`. For most use cases, you can query `db.load.avg` only.
@option params [Integer] :period_in_seconds
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are: * `1` (one second) * `60` (one minute) * `300` (five minutes) * `3600` (one hour) * `86400` (twenty-four hours) If you don't specify `PeriodInSeconds`, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.
@option params [required, Types::DimensionGroup] :group_by
A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
@option params [Types::DimensionGroup] :partition_by
For each dimension specified in `GroupBy`, specify a secondary dimension to further subdivide the partition keys in the response.
@option params [Hash<String,String>] :filter
One or more filters to apply in the request. Restrictions: * Any number of filters by the same dimension, as specified in the `GroupBy` or `Partition` parameters. * A single filter for any other dimension in this dimension group.
@option params [Integer] :max_results
The maximum number of items to return in the response. If more items exist than the specified `MaxRecords` 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 `MaxRecords`.
@return [Types::DescribeDimensionKeysResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::DescribeDimensionKeysResponse#aligned_start_time #aligned_start_time} => Time * {Types::DescribeDimensionKeysResponse#aligned_end_time #aligned_end_time} => Time * {Types::DescribeDimensionKeysResponse#partition_keys #partition_keys} => Array<Types::ResponsePartitionKey> * {Types::DescribeDimensionKeysResponse#keys #keys} => Array<Types::DimensionKeyDescription> * {Types::DescribeDimensionKeysResponse#next_token #next_token} => String
@example Request syntax with placeholder values
resp = client.describe_dimension_keys({ service_type: "RDS", # required, accepts RDS identifier: "RequestString", # required start_time: Time.now, # required end_time: Time.now, # required metric: "RequestString", # required period_in_seconds: 1, group_by: { # required group: "RequestString", # required dimensions: ["RequestString"], limit: 1, }, partition_by: { group: "RequestString", # required dimensions: ["RequestString"], limit: 1, }, filter: { "RequestString" => "RequestString", }, max_results: 1, next_token: "NextToken", })
@example Response structure
resp.aligned_start_time #=> Time resp.aligned_end_time #=> Time resp.partition_keys #=> Array resp.partition_keys[0].dimensions #=> Hash resp.partition_keys[0].dimensions["RequestString"] #=> String resp.keys #=> Array resp.keys[0].dimensions #=> Hash resp.keys[0].dimensions["RequestString"] #=> String resp.keys[0].total #=> Float resp.keys[0].partitions #=> Array resp.keys[0].partitions[0] #=> Float resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/DescribeDimensionKeys AWS API Documentation
@overload describe_dimension_keys
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-pi/client.rb, line 499 def describe_dimension_keys(params = {}, options = {}) req = build_request(:describe_dimension_keys, params) req.send_request(options) end
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.
@option params [required, String] :service_type
The AWS service for which Performance Insights returns data. The only valid value is `RDS`.
@option params [required, String] :identifier
The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an AWS Region. When a DB instance is the data source, specify its `DbiResourceId` value. For example, specify `db-ABCDEFGHIJKLMNOPQRSTU1VW2X`.
@option params [required, String] :group
The name of the dimension group. The only valid value is `db.sql`. Performance Insights searches the specified group for the dimension group ID.
@option params [required, String] :group_identifier
The ID of the dimension group from which to retrieve dimension details. For dimension group `db.sql`, the group ID is `db.sql.id`.
@option params [Array<String>] :requested_dimensions
A list of dimensions to retrieve the detail data for within the given dimension group. For the dimension group `db.sql`, specify either the full dimension name `db.sql.statement` or the short dimension name `statement`. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group.
@return [Types::GetDimensionKeyDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetDimensionKeyDetailsResponse#dimensions #dimensions} => Array<Types::DimensionKeyDetail>
@example Request syntax with placeholder values
resp = client.get_dimension_key_details({ service_type: "RDS", # required, accepts RDS identifier: "IdentifierString", # required group: "RequestString", # required group_identifier: "RequestString", # required requested_dimensions: ["RequestString"], })
@example Response structure
resp.dimensions #=> Array resp.dimensions[0].value #=> String resp.dimensions[0].dimension #=> String resp.dimensions[0].status #=> String, one of "AVAILABLE", "PROCESSING", "UNAVAILABLE"
@see docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetDimensionKeyDetails AWS API Documentation
@overload get_dimension_key_details
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-pi/client.rb, line 563 def get_dimension_key_details(params = {}, options = {}) req = build_request(:get_dimension_key_details, params) req.send_request(options) end
Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.
<note markdown=“1”> Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.
</note>
@option params [required, String] :service_type
The AWS service for which Performance Insights returns metrics. The only valid value for *ServiceType* is `RDS`.
@option params [required, String] :identifier
An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its `DbiResourceId` value. For example, specify `db-FAIHNTYBKTGAUSUZQYPDS2GW4A`.
@option params [required, Array<Types::MetricQuery>] :metric_queries
An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.
@option params [required, Time,DateTime,Date,Integer,String] :start_time
The date and time specifying the beginning of the requested time series data. You can't specify a `StartTime` that's earlier than 7 days ago. The value specified is *inclusive* - data points equal to or greater than `StartTime` will be returned. The value for `StartTime` must be earlier than the value for `EndTime`.
@option params [required, Time,DateTime,Date,Integer,String] :end_time
The date and time specifying the end of the requested time series data. The value specified is *exclusive* - data points less than (but not equal to) `EndTime` will be returned. The value for `EndTime` must be later than the value for `StartTime`.
@option params [Integer] :period_in_seconds
The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are: * `1` (one second) * `60` (one minute) * `300` (five minutes) * `3600` (one hour) * `86400` (twenty-four hours) If you don't specify `PeriodInSeconds`, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.
@option params [Integer] :max_results
The maximum number of items to return in the response. If more items exist than the specified `MaxRecords` 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 `MaxRecords`.
@return [Types::GetResourceMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
* {Types::GetResourceMetricsResponse#aligned_start_time #aligned_start_time} => Time * {Types::GetResourceMetricsResponse#aligned_end_time #aligned_end_time} => Time * {Types::GetResourceMetricsResponse#identifier #identifier} => String * {Types::GetResourceMetricsResponse#metric_list #metric_list} => Array<Types::MetricKeyDataPoints> * {Types::GetResourceMetricsResponse#next_token #next_token} => String
@example Request syntax with placeholder values
resp = client.get_resource_metrics({ service_type: "RDS", # required, accepts RDS identifier: "RequestString", # required metric_queries: [ # required { metric: "RequestString", # required group_by: { group: "RequestString", # required dimensions: ["RequestString"], limit: 1, }, filter: { "RequestString" => "RequestString", }, }, ], start_time: Time.now, # required end_time: Time.now, # required period_in_seconds: 1, max_results: 1, next_token: "NextToken", })
@example Response structure
resp.aligned_start_time #=> Time resp.aligned_end_time #=> Time resp.identifier #=> String resp.metric_list #=> Array resp.metric_list[0].key.metric #=> String resp.metric_list[0].key.dimensions #=> Hash resp.metric_list[0].key.dimensions["RequestString"] #=> String resp.metric_list[0].data_points #=> Array resp.metric_list[0].data_points[0].timestamp #=> Time resp.metric_list[0].data_points[0].value #=> Float resp.next_token #=> String
@see docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27/GetResourceMetrics AWS API Documentation
@overload get_resource_metrics
(params = {}) @param [Hash] params ({})
# File lib/aws-sdk-pi/client.rb, line 692 def get_resource_metrics(params = {}, options = {}) req = build_request(:get_resource_metrics, params) req.send_request(options) end
@api private @deprecated
# File lib/aws-sdk-pi/client.rb, line 716 def waiter_names [] end