You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::PI::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS Performance Insights. To construct a client, you need to configure a :region and :credentials.

pi = Aws::PI::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::PI::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::PI::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Aws::Plugins::RequestSigner for more details.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Aws::Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Aws::Plugins::RequestSigner for more details.
  • :endpoint (String)

    A default endpoint is constructed from the :region. See Aws::Plugins::RegionalEndpoint for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Aws::Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Aws::Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Aws::Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Aws::Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Aws::Plugins::RegionalEndpoint for more details.

  • :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 and auth errors from expired credentials. See Aws::Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Aws::Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Aws::Plugins::RequestSigner for more details.

  • :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. See Aws::Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Aws::Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Aws::Plugins::ParamValidator for more details.

Instance Method Details

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

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

Examples:

Request syntax with placeholder values


resp = client.describe_dimension_keys({
  service_type: "RDS", # required, accepts RDS
  identifier: "String", # required
  start_time: Time.now, # required
  end_time: Time.now, # required
  metric: "String", # required
  period_in_seconds: 1,
  group_by: { # required
    group: "String", # required
    dimensions: ["String"],
    limit: 1,
  },
  partition_by: {
    group: "String", # required
    dimensions: ["String"],
    limit: 1,
  },
  filter: {
    "String" => "String",
  },
  max_results: 1,
  next_token: "String",
})

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["String"] #=> String
resp.keys #=> Array
resp.keys[0].dimensions #=> Hash
resp.keys[0].dimensions["String"] #=> String
resp.keys[0].total #=> Float
resp.keys[0].partitions #=> Array
resp.keys[0].partitions[0] #=> Float
resp.next_token #=> String

Options Hash (options):

  • :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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

  • :start_time (required, 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.

  • :end_time (required, 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.

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

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

  • :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 will return all of the dimensions within that group, unless you provide the names of specific dimensions within that 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:

See Also:

#get_resource_metrics(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.get_resource_metrics({
  service_type: "RDS", # required, accepts RDS
  identifier: "String", # required
  metric_queries: [ # required
    {
      metric: "String", # required
      group_by: {
        group: "String", # required
        dimensions: ["String"],
        limit: 1,
      },
      filter: {
        "String" => "String",
      },
    },
  ],
  start_time: Time.now, # required
  end_time: Time.now, # required
  period_in_seconds: 1,
  max_results: 1,
  next_token: "String",
})

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["String"] #=> 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

Options Hash (options):

  • :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: 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)

    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)

    The date and time specifiying 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:

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.