github.com/aavshr/aws-sdk-go@v1.41.3/service/pi/doc.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package pi provides the client and types for making API
     4  // requests to AWS Performance Insights.
     5  //
     6  // Amazon RDS Performance Insights enables you to monitor and explore different
     7  // dimensions of database load based on data captured from a running DB instance.
     8  // The guide provides detailed information about Performance Insights data types,
     9  // parameters and errors.
    10  //
    11  // When Performance Insights is enabled, the Amazon RDS Performance Insights
    12  // API provides visibility into the performance of your DB instance. Amazon
    13  // CloudWatch provides the authoritative source for AWS service-vended monitoring
    14  // metrics. Performance Insights offers a domain-specific view of DB load.
    15  //
    16  // DB load is measured as Average Active Sessions. Performance Insights provides
    17  // the data to API consumers as a two-dimensional time-series dataset. The time
    18  // dimension provides DB load data for each time point in the queried time range.
    19  // Each time point decomposes overall load in relation to the requested dimensions,
    20  // measured at that time point. Examples include SQL, Wait event, User, and
    21  // Host.
    22  //
    23  //    * To learn more about Performance Insights and Amazon Aurora DB instances,
    24  //    go to the Amazon Aurora User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html).
    25  //
    26  //    * To learn more about Performance Insights and Amazon RDS DB instances,
    27  //    go to the Amazon RDS User Guide (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html).
    28  //
    29  // See https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27 for more information on this service.
    30  //
    31  // See pi package documentation for more information.
    32  // https://docs.aws.amazon.com/sdk-for-go/api/service/pi/
    33  //
    34  // Using the Client
    35  //
    36  // To contact AWS Performance Insights with the SDK use the New function to create
    37  // a new service client. With that client you can make API requests to the service.
    38  // These clients are safe to use concurrently.
    39  //
    40  // See the SDK's documentation for more information on how to use the SDK.
    41  // https://docs.aws.amazon.com/sdk-for-go/api/
    42  //
    43  // See aws.Config documentation for more information on configuring SDK clients.
    44  // https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
    45  //
    46  // See the AWS Performance Insights client PI for more
    47  // information on creating client for this service.
    48  // https://docs.aws.amazon.com/sdk-for-go/api/service/pi/#New
    49  package pi