aws

# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.

defmodule AWS.PI do
  @moduledoc """
  Amazon RDS Performance Insights

  Amazon RDS Performance Insights enables you to monitor and explore different
  dimensions of database load based on data captured from a running DB instance.

  The guide provides detailed information about Performance Insights data types,
  parameters and errors.

  When Performance Insights is enabled, the Amazon RDS Performance Insights API
  provides visibility into the performance of your DB instance. Amazon CloudWatch
  provides the authoritative source for AWS service-vended monitoring metrics.
  Performance Insights offers a domain-specific view of DB load.

  DB load is measured as Average Active Sessions. Performance Insights provides
  the data to API consumers as a two-dimensional time-series dataset. The time
  dimension provides DB load data for each time point in the queried time range.
  Each time point decomposes overall load in relation to the requested dimensions,
  measured at that time point. Examples include SQL, Wait event, User, and Host.

    * To learn more about Performance Insights and Amazon Aurora DB
  instances, go to the [Amazon Aurora User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html).

    * To learn more about Performance Insights and Amazon RDS DB
  instances, go to the [Amazon RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html).
  """

  alias AWS.Client
  alias AWS.Request

  def metadata do
    %AWS.ServiceMetadata{
      abbreviation: "AWS PI",
      api_version: "2018-02-27",
      content_type: "application/x-amz-json-1.1",
      credential_scope: nil,
      endpoint_prefix: "pi",
      global?: false,
      protocol: "json",
      service_id: "PI",
      signature_version: "v4",
      signing_name: "pi",
      target_prefix: "PerformanceInsightsv20180227"
    }
  end

  @doc """
  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.
  """
  def describe_dimension_keys(%Client{} = client, input, options \\ []) do
    Request.request_post(client, metadata(), "DescribeDimensionKeys", input, options)
  end

  @doc """
  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.
  """
  def get_dimension_key_details(%Client{} = client, input, options \\ []) do
    Request.request_post(client, metadata(), "GetDimensionKeyDetails", input, options)
  end

  @doc """
  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.
  """
  def get_resource_metrics(%Client{} = client, input, options \\ []) do
    Request.request_post(client, metadata(), "GetResourceMetrics", input, options)
  end
end