« blib/lib/Paws/Config/DescribeComplianceByConfigRuleResponse.pm
↑ Summary
blib/lib/Paws/Config/DescribeComplianceByResourceResponse.pm »
| 1 | |||
| 2 | package Paws::Config::DescribeComplianceByResource; | ||
| 3 | use Moose; | ||
| 4 | has ComplianceTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has Limit => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has ResourceId => (is => 'ro', isa => 'Str'); | ||
| 8 | has ResourceType => (is => 'ro', isa => 'Str'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeComplianceByResource'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Config::DescribeComplianceByResourceResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Config::DescribeComplianceByResource - Arguments for method DescribeComplianceByResource on L<Paws::Config> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribeComplianceByResource on the | ||
| 26 | L<AWS Config|Paws::Config> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribeComplianceByResource. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeComplianceByResource. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $config = Paws->service('Config'); | ||
| 34 | my $DescribeComplianceByResourceResponse = | ||
| 35 | $config->DescribeComplianceByResource( | ||
| 36 | ComplianceTypes => [ | ||
| 37 | 'COMPLIANT', | ||
| 38 | ... # values: COMPLIANT, NON_COMPLIANT, NOT_APPLICABLE, INSUFFICIENT_DATA | ||
| 39 | ], # OPTIONAL | ||
| 40 | Limit => 1, # OPTIONAL | ||
| 41 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 42 | ResourceId => 'MyBaseResourceId', # OPTIONAL | ||
| 43 | ResourceType => 'MyStringWithCharLimit256', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $ComplianceByResources = | ||
| 48 | $DescribeComplianceByResourceResponse->ComplianceByResources; | ||
| 49 | my $NextToken = $DescribeComplianceByResourceResponse->NextToken; | ||
| 50 | |||
| 51 | # Returns a L<Paws::Config::DescribeComplianceByResourceResponse> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/config/DescribeComplianceByResource> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 ComplianceTypes => ArrayRef[Str|Undef] | ||
| 60 | |||
| 61 | Filters the results by compliance. | ||
| 62 | |||
| 63 | The allowed values are C<COMPLIANT>, C<NON_COMPLIANT>, and | ||
| 64 | C<INSUFFICIENT_DATA>. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Limit => Int | ||
| 69 | |||
| 70 | The maximum number of evaluation results returned on each page. The | ||
| 71 | default is 10. You cannot specify a number greater than 100. If you | ||
| 72 | specify 0, AWS Config uses the default. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 NextToken => Str | ||
| 77 | |||
| 78 | The C<nextToken> string returned on a previous page that you use to get | ||
| 79 | the next page of results in a paginated response. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 ResourceId => Str | ||
| 84 | |||
| 85 | The ID of the AWS resource for which you want compliance information. | ||
| 86 | You can specify only one resource ID. If you specify a resource ID, you | ||
| 87 | must also specify a type for C<ResourceType>. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 ResourceType => Str | ||
| 92 | |||
| 93 | The types of AWS resources for which you want compliance information | ||
| 94 | (for example, C<AWS::EC2::Instance>). For this action, you can specify | ||
| 95 | that the resource type is an AWS account by specifying | ||
| 96 | C<AWS::::Account>. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method DescribeComplianceByResource in L<Paws::Config> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |