« blib/lib/Paws/Outposts/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/PerformanceInsights/DataPoint.pm »
| 1 | package Paws::PerformanceInsights; | ||
| 2 | use Moose; | ||
| 3 | sub service { 'pi' } | ||
| 4 | sub signing_name { 'pi' } | ||
| 5 | sub version { '2018-02-27' } | ||
| 6 | sub target_prefix { 'PerformanceInsightsv20180227' } | ||
| 7 | sub json_version { "1.1" } | ||
| 8 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | ||
| 9 | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||
| 10 | { base => 'rand', type => 'exponential', growth_factor => 2 } | ||
| 11 | }); | ||
| 12 | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||
| 13 | ] }); | ||
| 14 | |||
| 15 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::JsonCaller'; | ||
| 16 | |||
| 17 | |||
| 18 | sub DescribeDimensionKeys { | ||
| 19 | my $self = shift; | ||
| 20 | my $call_object = $self->new_with_coercions('Paws::PerformanceInsights::DescribeDimensionKeys', @_); | ||
| 21 | return $self->caller->do_call($self, $call_object); | ||
| 22 | } | ||
| 23 | sub GetDimensionKeyDetails { | ||
| 24 | my $self = shift; | ||
| 25 | my $call_object = $self->new_with_coercions('Paws::PerformanceInsights::GetDimensionKeyDetails', @_); | ||
| 26 | return $self->caller->do_call($self, $call_object); | ||
| 27 | } | ||
| 28 | sub GetResourceMetrics { | ||
| 29 | my $self = shift; | ||
| 30 | my $call_object = $self->new_with_coercions('Paws::PerformanceInsights::GetResourceMetrics', @_); | ||
| 31 | return $self->caller->do_call($self, $call_object); | ||
| 32 | } | ||
| 33 | |||
| 34 | |||
| 35 | |||
| 36 | sub operations { qw/DescribeDimensionKeys GetDimensionKeyDetails GetResourceMetrics / } | ||
| 37 | |||
| 38 | 1; | ||
| 39 | |||
| 40 | ### main pod documentation begin ### | ||
| 41 | |||
| 42 | =head1 NAME | ||
| 43 | |||
| 44 | Paws::PerformanceInsights - Perl Interface to AWS AWS Performance Insights | ||
| 45 | |||
| 46 | =head1 SYNOPSIS | ||
| 47 | |||
| 48 | use Paws; | ||
| 49 | |||
| 50 | my $obj = Paws->service('PerformanceInsights'); | ||
| 51 | my $res = $obj->Method( | ||
| 52 | Arg1 => $val1, | ||
| 53 | Arg2 => [ 'V1', 'V2' ], | ||
| 54 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||
| 55 | # of the arguments type | ||
| 56 | Arg3 => { Att1 => 'Val1' }, | ||
| 57 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||
| 58 | # the constructor of the arguments type | ||
| 59 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||
| 60 | ); | ||
| 61 | |||
| 62 | =head1 DESCRIPTION | ||
| 63 | |||
| 64 | Amazon RDS Performance Insights | ||
| 65 | |||
| 66 | Amazon RDS Performance Insights enables you to monitor and explore | ||
| 67 | different dimensions of database load based on data captured from a | ||
| 68 | running DB instance. The guide provides detailed information about | ||
| 69 | Performance Insights data types, parameters and errors. | ||
| 70 | |||
| 71 | When Performance Insights is enabled, the Amazon RDS Performance | ||
| 72 | Insights API provides visibility into the performance of your DB | ||
| 73 | instance. Amazon CloudWatch provides the authoritative source for AWS | ||
| 74 | service-vended monitoring metrics. Performance Insights offers a | ||
| 75 | domain-specific view of DB load. | ||
| 76 | |||
| 77 | DB load is measured as Average Active Sessions. Performance Insights | ||
| 78 | provides the data to API consumers as a two-dimensional time-series | ||
| 79 | dataset. The time dimension provides DB load data for each time point | ||
| 80 | in the queried time range. Each time point decomposes overall load in | ||
| 81 | relation to the requested dimensions, measured at that time point. | ||
| 82 | Examples include SQL, Wait event, User, and Host. | ||
| 83 | |||
| 84 | =over | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | To learn more about Performance Insights and Amazon Aurora DB | ||
| 89 | instances, go to the Amazon Aurora User Guide | ||
| 90 | (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_PerfInsights.html). | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | To learn more about Performance Insights and Amazon RDS DB instances, | ||
| 95 | go to the Amazon RDS User Guide | ||
| 96 | (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html). | ||
| 97 | |||
| 98 | =back | ||
| 99 | |||
| 100 | |||
| 101 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pi-2018-02-27> | ||
| 102 | |||
| 103 | |||
| 104 | =head1 METHODS | ||
| 105 | |||
| 106 | =head2 DescribeDimensionKeys | ||
| 107 | |||
| 108 | =over | ||
| 109 | |||
| 110 | =item EndTime => Str | ||
| 111 | |||
| 112 | =item GroupBy => L<Paws::PerformanceInsights::DimensionGroup> | ||
| 113 | |||
| 114 | =item Identifier => Str | ||
| 115 | |||
| 116 | =item Metric => Str | ||
| 117 | |||
| 118 | =item ServiceType => Str | ||
| 119 | |||
| 120 | =item StartTime => Str | ||
| 121 | |||
| 122 | =item [Filter => L<Paws::PerformanceInsights::MetricQueryFilterMap>] | ||
| 123 | |||
| 124 | =item [MaxResults => Int] | ||
| 125 | |||
| 126 | =item [NextToken => Str] | ||
| 127 | |||
| 128 | =item [PartitionBy => L<Paws::PerformanceInsights::DimensionGroup>] | ||
| 129 | |||
| 130 | =item [PeriodInSeconds => Int] | ||
| 131 | |||
| 132 | |||
| 133 | =back | ||
| 134 | |||
| 135 | Each argument is described in detail in: L<Paws::PerformanceInsights::DescribeDimensionKeys> | ||
| 136 | |||
| 137 | Returns: a L<Paws::PerformanceInsights::DescribeDimensionKeysResponse> instance | ||
| 138 | |||
| 139 | For a specific time period, retrieve the top C<N> dimension keys for a | ||
| 140 | metric. | ||
| 141 | |||
| 142 | Each response element returns a maximum of 500 bytes. For larger | ||
| 143 | elements, such as SQL statements, only the first 500 bytes are | ||
| 144 | returned. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 GetDimensionKeyDetails | ||
| 148 | |||
| 149 | =over | ||
| 150 | |||
| 151 | =item Group => Str | ||
| 152 | |||
| 153 | =item GroupIdentifier => Str | ||
| 154 | |||
| 155 | =item Identifier => Str | ||
| 156 | |||
| 157 | =item ServiceType => Str | ||
| 158 | |||
| 159 | =item [RequestedDimensions => ArrayRef[Str|Undef]] | ||
| 160 | |||
| 161 | |||
| 162 | =back | ||
| 163 | |||
| 164 | Each argument is described in detail in: L<Paws::PerformanceInsights::GetDimensionKeyDetails> | ||
| 165 | |||
| 166 | Returns: a L<Paws::PerformanceInsights::GetDimensionKeyDetailsResponse> instance | ||
| 167 | |||
| 168 | Get the attributes of the specified dimension group for a DB instance | ||
| 169 | or data source. For example, if you specify a SQL ID, | ||
| 170 | C<GetDimensionKeyDetails> retrieves the full text of the dimension | ||
| 171 | C<db.sql.statement> associated with this ID. This operation is useful | ||
| 172 | because C<GetResourceMetrics> and C<DescribeDimensionKeys> don't | ||
| 173 | support retrieval of large SQL statement text. | ||
| 174 | |||
| 175 | |||
| 176 | =head2 GetResourceMetrics | ||
| 177 | |||
| 178 | =over | ||
| 179 | |||
| 180 | =item EndTime => Str | ||
| 181 | |||
| 182 | =item Identifier => Str | ||
| 183 | |||
| 184 | =item MetricQueries => ArrayRef[L<Paws::PerformanceInsights::MetricQuery>] | ||
| 185 | |||
| 186 | =item ServiceType => Str | ||
| 187 | |||
| 188 | =item StartTime => Str | ||
| 189 | |||
| 190 | =item [MaxResults => Int] | ||
| 191 | |||
| 192 | =item [NextToken => Str] | ||
| 193 | |||
| 194 | =item [PeriodInSeconds => Int] | ||
| 195 | |||
| 196 | |||
| 197 | =back | ||
| 198 | |||
| 199 | Each argument is described in detail in: L<Paws::PerformanceInsights::GetResourceMetrics> | ||
| 200 | |||
| 201 | Returns: a L<Paws::PerformanceInsights::GetResourceMetricsResponse> instance | ||
| 202 | |||
| 203 | Retrieve Performance Insights metrics for a set of data sources, over a | ||
| 204 | time period. You can provide specific dimension groups and dimensions, | ||
| 205 | and provide aggregation and filtering criteria for each group. | ||
| 206 | |||
| 207 | Each response element returns a maximum of 500 bytes. For larger | ||
| 208 | elements, such as SQL statements, only the first 500 bytes are | ||
| 209 | returned. | ||
| 210 | |||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head1 PAGINATORS | ||
| 215 | |||
| 216 | Paginator methods are helpers that repetively call methods that return partial results | ||
| 217 | |||
| 218 | |||
| 219 | |||
| 220 | |||
| 221 | =head1 SEE ALSO | ||
| 222 | |||
| 223 | This service class forms part of L<Paws> | ||
| 224 | |||
| 225 | =head1 BUGS and CONTRIBUTIONS | ||
| 226 | |||
| 227 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 228 | |||
| 229 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 230 | |||
| 231 | =cut | ||
| 232 |