« blib/lib/Paws/PerformanceInsights/DimensionMap.pm
↑ Summary
blib/lib/Paws/PerformanceInsights/GetDimensionKeyDetailsResponse.pm »
| 1 | |||
| 2 | package Paws::PerformanceInsights::GetDimensionKeyDetails; | ||
| 3 | use Moose; | ||
| 4 | has Group => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has GroupIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Identifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has RequestedDimensions => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has ServiceType => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDimensionKeyDetails'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::PerformanceInsights::GetDimensionKeyDetailsResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::PerformanceInsights::GetDimensionKeyDetails - Arguments for method GetDimensionKeyDetails on L<Paws::PerformanceInsights> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetDimensionKeyDetails on the | ||
| 26 | L<AWS Performance Insights|Paws::PerformanceInsights> service. Use the attributes of this class | ||
| 27 | as arguments to method GetDimensionKeyDetails. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDimensionKeyDetails. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $pi = Paws->service('PerformanceInsights'); | ||
| 34 | my $GetDimensionKeyDetailsResponse = $pi->GetDimensionKeyDetails( | ||
| 35 | Group => 'MyRequestString', | ||
| 36 | GroupIdentifier => 'MyRequestString', | ||
| 37 | Identifier => 'MyIdentifierString', | ||
| 38 | ServiceType => 'RDS', | ||
| 39 | RequestedDimensions => [ | ||
| 40 | 'MyRequestString', ... # max: 256 | ||
| 41 | ], # OPTIONAL | ||
| 42 | ); | ||
| 43 | |||
| 44 | # Results: | ||
| 45 | my $Dimensions = $GetDimensionKeyDetailsResponse->Dimensions; | ||
| 46 | |||
| 47 | # Returns a L<Paws::PerformanceInsights::GetDimensionKeyDetailsResponse> object. | ||
| 48 | |||
| 49 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/pi/GetDimensionKeyDetails> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> Group => Str | ||
| 56 | |||
| 57 | The name of the dimension group. The only valid value is C<db.sql>. | ||
| 58 | Performance Insights searches the specified group for the dimension | ||
| 59 | group ID. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> GroupIdentifier => Str | ||
| 64 | |||
| 65 | The ID of the dimension group from which to retrieve dimension details. | ||
| 66 | For dimension group C<db.sql>, the group ID is C<db.sql.id>. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Identifier => Str | ||
| 71 | |||
| 72 | The ID for a data source from which to gather dimension data. This ID | ||
| 73 | must be immutable and unique within an AWS Region. When a DB instance | ||
| 74 | is the data source, specify its C<DbiResourceId> value. For example, | ||
| 75 | specify C<db-ABCDEFGHIJKLMNOPQRSTU1VW2X>. | ||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 RequestedDimensions => ArrayRef[Str|Undef] | ||
| 80 | |||
| 81 | A list of dimensions to retrieve the detail data for within the given | ||
| 82 | dimension group. For the dimension group C<db.sql>, specify either the | ||
| 83 | full dimension name C<db.sql.statement> or the short dimension name | ||
| 84 | C<statement>. If you don't specify this parameter, Performance Insights | ||
| 85 | returns all dimension data within the specified dimension group. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> ServiceType => Str | ||
| 90 | |||
| 91 | The AWS service for which Performance Insights returns data. The only | ||
| 92 | valid value is C<RDS>. | ||
| 93 | |||
| 94 | Valid values are: C<"RDS"> | ||
| 95 | |||
| 96 | |||
| 97 | =head1 SEE ALSO | ||
| 98 | |||
| 99 | This class forms part of L<Paws>, documenting arguments for method GetDimensionKeyDetails in L<Paws::PerformanceInsights> | ||
| 100 | |||
| 101 | =head1 BUGS and CONTRIBUTIONS | ||
| 102 | |||
| 103 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 104 | |||
| 105 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 106 | |||
| 107 | =cut | ||
| 108 |