« blib/lib/Paws/Config/FieldInfo.pm
↑ Summary
blib/lib/Paws/Config/GetAggregateComplianceDetailsByConfigRuleResponse.pm »
| 1 | |||
| 2 | package Paws::Config::GetAggregateComplianceDetailsByConfigRule; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AwsRegion => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has ComplianceType => (is => 'ro', isa => 'Str'); | ||
| 7 | has ConfigRuleName => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ConfigurationAggregatorName => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Limit => (is => 'ro', isa => 'Int'); | ||
| 10 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetAggregateComplianceDetailsByConfigRule'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Config::GetAggregateComplianceDetailsByConfigRuleResponse'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Config::GetAggregateComplianceDetailsByConfigRule - Arguments for method GetAggregateComplianceDetailsByConfigRule on L<Paws::Config> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetAggregateComplianceDetailsByConfigRule on the | ||
| 28 | L<AWS Config|Paws::Config> service. Use the attributes of this class | ||
| 29 | as arguments to method GetAggregateComplianceDetailsByConfigRule. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetAggregateComplianceDetailsByConfigRule. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $config = Paws->service('Config'); | ||
| 36 | my $GetAggregateComplianceDetailsByConfigRuleResponse = | ||
| 37 | $config->GetAggregateComplianceDetailsByConfigRule( | ||
| 38 | AccountId => 'MyAccountId', | ||
| 39 | AwsRegion => 'MyAwsRegion', | ||
| 40 | ConfigRuleName => 'MyConfigRuleName', | ||
| 41 | ConfigurationAggregatorName => 'MyConfigurationAggregatorName', | ||
| 42 | ComplianceType => 'COMPLIANT', # OPTIONAL | ||
| 43 | Limit => 1, # OPTIONAL | ||
| 44 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $AggregateEvaluationResults = | ||
| 49 | $GetAggregateComplianceDetailsByConfigRuleResponse | ||
| 50 | ->AggregateEvaluationResults; | ||
| 51 | my $NextToken = | ||
| 52 | $GetAggregateComplianceDetailsByConfigRuleResponse->NextToken; | ||
| 53 | |||
| 54 | # Returns a L<Paws::Config::GetAggregateComplianceDetailsByConfigRuleResponse> object. | ||
| 55 | |||
| 56 | 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. | ||
| 57 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/config/GetAggregateComplianceDetailsByConfigRule> | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 B<REQUIRED> AccountId => Str | ||
| 63 | |||
| 64 | The 12-digit account ID of the source account. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> AwsRegion => Str | ||
| 69 | |||
| 70 | The source region from where the data is aggregated. | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 ComplianceType => Str | ||
| 75 | |||
| 76 | The resource compliance status. | ||
| 77 | |||
| 78 | For the C<GetAggregateComplianceDetailsByConfigRuleRequest> data type, | ||
| 79 | AWS Config supports only the C<COMPLIANT> and C<NON_COMPLIANT>. AWS | ||
| 80 | Config does not support the C<NOT_APPLICABLE> and C<INSUFFICIENT_DATA> | ||
| 81 | values. | ||
| 82 | |||
| 83 | Valid values are: C<"COMPLIANT">, C<"NON_COMPLIANT">, C<"NOT_APPLICABLE">, C<"INSUFFICIENT_DATA"> | ||
| 84 | |||
| 85 | =head2 B<REQUIRED> ConfigRuleName => Str | ||
| 86 | |||
| 87 | The name of the AWS Config rule for which you want compliance | ||
| 88 | information. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> ConfigurationAggregatorName => Str | ||
| 93 | |||
| 94 | The name of the configuration aggregator. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head2 Limit => Int | ||
| 99 | |||
| 100 | The maximum number of evaluation results returned on each page. The | ||
| 101 | default is 50. You cannot specify a number greater than 100. If you | ||
| 102 | specify 0, AWS Config uses the default. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 NextToken => Str | ||
| 107 | |||
| 108 | The C<nextToken> string returned on a previous page that you use to get | ||
| 109 | the next page of results in a paginated response. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head1 SEE ALSO | ||
| 115 | |||
| 116 | This class forms part of L<Paws>, documenting arguments for method GetAggregateComplianceDetailsByConfigRule in L<Paws::Config> | ||
| 117 | |||
| 118 | =head1 BUGS and CONTRIBUTIONS | ||
| 119 | |||
| 120 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 121 | |||
| 122 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 123 | |||
| 124 | =cut | ||
| 125 |