pi: AWS Performance Insights

In paws: Amazon Web Services Software Development Kit

AWS Performance Insights

Description

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 Amazon Web Services 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 .

• To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .

• To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .

Usage

pi(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- pi(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_performance_analysis_report	Creates a new performance analysis report for a specific time period for the DB instance
delete_performance_analysis_report	Deletes a performance analysis report
describe_dimension_keys	For a specific time period, retrieve the top N dimension keys for a metric
get_dimension_key_details	Get the attributes of the specified dimension group for a DB instance or data source
get_performance_analysis_report	Retrieves the report including the report ID, status, time details, and the insights with recommendations
get_resource_metadata	Retrieve the metadata for different features
get_resource_metrics	Retrieve Performance Insights metrics for a set of data sources over a time period
list_available_resource_dimensions	Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance
list_available_resource_metrics	Retrieve metrics of the specified types that can be queried for a specified DB instance
list_performance_analysis_reports	Lists all the analysis reports created for the DB instance
list_tags_for_resource	Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource
tag_resource	Adds metadata tags to the Amazon RDS Performance Insights resource
untag_resource	Deletes the metadata tags from the Amazon RDS Performance Insights resource

Examples

## Not run: 
svc <- pi()
svc$create_performance_analysis_report(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.