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

#config, #handlers

API Operations

• #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_resource_metrics(params = {}) ⇒ Types::GetResourceMetricsResponse

  Retrieve Performance Insights metrics for a set of data sources, over a time period.

Instance Method Summary

• #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.

Parameters:

• options (Hash)

Options Hash (options):

• :credentials (required, Aws::CredentialProvider) —

  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.
• :region (required, String) —

  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
• :access_key_id (String)
• :active_endpoint_cache (Boolean) — default: false —

  When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

• :adaptive_retry_wait_to_fill (Boolean) — default: 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.

• :client_side_monitoring (Boolean) — default: false —

  When true, client-side metrics will be collected for all API requests from this client.

• :client_side_monitoring_client_id (String) — default: "" —

  Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

• :client_side_monitoring_host (String) — default: "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.

• :client_side_monitoring_port (Integer) — default: 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.

• :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

  Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

• :convert_params (Boolean) — default: true —

  When true, an attempt is made to coerce request parameters into the required types.

• :correct_clock_skew (Boolean) — default: true —

  Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

• :disable_host_prefix_injection (Boolean) — default: false —

  Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

• :endpoint (String) —

  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.

• :endpoint_cache_max_entries (Integer) — default: 1000 —

  Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

• :endpoint_cache_max_threads (Integer) — default: 10 —

  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

• :endpoint_cache_poll_interval (Integer) — default: 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.

• :endpoint_discovery (Boolean) — default: false —

  When set to true, endpoint discovery will be enabled for operations when available.

• :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

  The log formatter.

• :log_level (Symbol) — default: :info —

  The log level to send messages to the :logger at.

• :logger (Logger) —

  The Logger instance to send log messages to. If this option is not set, logging will be disabled.

• :max_attempts (Integer) — default: 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.

• :profile (String) — default: "default" —

  Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

• :retry_backoff (Proc) —

  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

• :retry_base_delay (Float) — default: 0.3 —

  The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

• :retry_jitter (Symbol) — default: :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

• :retry_limit (Integer) — default: 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.

• :retry_max_delay (Integer) — default: 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.

• :retry_mode (String) — default: "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.

• :secret_access_key (String)
• :session_token (String)
• :simple_json (Boolean) — default: 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.

• :stub_responses (Boolean) — default: 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.

• :validate_params (Boolean) — default: true —

  When true, request parameters are validated before sending the request.

• :http_proxy (URI::HTTP, String) —

  A proxy to send requests through. Formatted like 'http://proxy.com:123'.

• :http_open_timeout (Float) — default: 15 —

  The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

• :http_read_timeout (Integer) — default: 60 —

  The default number of seconds to wait for response data. This value can safely be set per-request on the session.

• :http_idle_timeout (Float) — default: 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.

• :http_continue_timeout (Float) — default: 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.

• :http_wire_trace (Boolean) — default: false —

  When true, HTTP debug output will be sent to the :logger.

• :ssl_verify_peer (Boolean) — default: true —

  When true, SSL peer certificates are verified when establishing a connection.

• :ssl_ca_bundle (String) —

  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.

• :ssl_ca_directory (String) —

  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 'gems/aws-sdk-pi/lib/aws-sdk-pi/client.rb', line 334

def initialize(*args)
  super
end

Instance Method Details

#describe_dimension_keys(params = {}) ⇒ Types::DescribeDimensionKeysResponse

For a specific time period, retrieve the top N dimension keys for a metric.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Examples:

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",
})

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

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :service_type (required, String) —

  The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is RDS.

• :identifier (required, String) —

  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

• :start_time (required, Time, DateTime, Date, Integer, String) —

  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.

• :end_time (required, Time, DateTime, Date, Integer, String) —

  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.

• :metric (required, String) —

  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.

• :period_in_seconds (Integer) —

  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.

• :group_by (required, Types::DimensionGroup) —

  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.

• :partition_by (Types::DimensionGroup) —

  For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

• :filter (Hash<String,String>) —

  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.

• :max_results (Integer) —

  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.

• :next_token (String) —

  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.

Returns:

• (Types::DescribeDimensionKeysResponse) —

  Returns a response object which responds to the following methods:

  • #aligned_start_time => Time
  • #aligned_end_time => Time
  • #partition_keys => Array<Types::ResponsePartitionKey>
  • #keys => Array<Types::DimensionKeyDescription>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-pi/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_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.

Examples:

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"],
})

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"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :service_type (required, String) —

  The AWS service for which Performance Insights returns data. The only valid value is RDS.

• :identifier (required, String) —

  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.

• :group (required, String) —

  The name of the dimension group. The only valid value is db.sql. Performance Insights searches the specified group for the dimension group ID.

• :group_identifier (required, String) —

  The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id.

• :requested_dimensions (Array<String>) —

  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.

Returns:

• (Types::GetDimensionKeyDetailsResponse) —

  Returns a response object which responds to the following methods:

  • #dimensions => Array<Types::DimensionKeyDetail>

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-pi/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

#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 aggregation and filtering criteria for each group.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Examples:

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",
})

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

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :service_type (required, String) —

  The AWS service for which Performance Insights returns metrics. The only valid value for ServiceType is RDS.

• :identifier (required, String) —

  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.

• :metric_queries (required, Array<Types::MetricQuery>) —

  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.

• :start_time (required, Time, DateTime, Date, Integer, String) —

  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.

• :end_time (required, Time, DateTime, Date, Integer, String) —

  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.

• :period_in_seconds (Integer) —

  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.

• :max_results (Integer) —

  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.

• :next_token (String) —

  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.

Returns:

• (Types::GetResourceMetricsResponse) —

  Returns a response object which responds to the following methods:

  • #aligned_start_time => Time
  • #aligned_end_time => Time
  • #identifier => String
  • #metric_list => Array<Types::MetricKeyDataPoints>
  • #next_token => String

See Also:

• AWS API Documentation

# File 'gems/aws-sdk-pi/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