« blib/lib/Paws/ResourceTagging/FailureInfo.pm
↑ Summary
blib/lib/Paws/ResourceTagging/GetComplianceSummaryOutput.pm »
| 1 | |||
| 2 | package Paws::ResourceTagging::GetComplianceSummary; | ||
| 3 | use Moose; | ||
| 4 | has GroupBy => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has PaginationToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has RegionFilters => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has ResourceTypeFilters => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 9 | has TagKeyFilters => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has TargetIdFilters => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetComplianceSummary'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ResourceTagging::GetComplianceSummaryOutput'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::ResourceTagging::GetComplianceSummary - Arguments for method GetComplianceSummary on L<Paws::ResourceTagging> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method GetComplianceSummary on the | ||
| 28 | L<AWS Resource Groups Tagging API|Paws::ResourceTagging> service. Use the attributes of this class | ||
| 29 | as arguments to method GetComplianceSummary. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetComplianceSummary. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $tagging = Paws->service('ResourceTagging'); | ||
| 36 | my $GetComplianceSummaryOutput = $tagging->GetComplianceSummary( | ||
| 37 | GroupBy => [ | ||
| 38 | 'TARGET_ID', ... # values: TARGET_ID, REGION, RESOURCE_TYPE | ||
| 39 | ], # OPTIONAL | ||
| 40 | MaxResults => 1, # OPTIONAL | ||
| 41 | PaginationToken => 'MyPaginationToken', # OPTIONAL | ||
| 42 | RegionFilters => [ | ||
| 43 | 'MyRegion', ... # min: 1, max: 256 | ||
| 44 | ], # OPTIONAL | ||
| 45 | ResourceTypeFilters => [ | ||
| 46 | 'MyAmazonResourceType', ... # max: 256 | ||
| 47 | ], # OPTIONAL | ||
| 48 | TagKeyFilters => [ | ||
| 49 | 'MyTagKey', ... # min: 1, max: 128 | ||
| 50 | ], # OPTIONAL | ||
| 51 | TargetIdFilters => [ | ||
| 52 | 'MyTargetId', ... # min: 6, max: 68 | ||
| 53 | ], # OPTIONAL | ||
| 54 | ); | ||
| 55 | |||
| 56 | # Results: | ||
| 57 | my $PaginationToken = $GetComplianceSummaryOutput->PaginationToken; | ||
| 58 | my $SummaryList = $GetComplianceSummaryOutput->SummaryList; | ||
| 59 | |||
| 60 | # Returns a L<Paws::ResourceTagging::GetComplianceSummaryOutput> object. | ||
| 61 | |||
| 62 | 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. | ||
| 63 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/tagging/GetComplianceSummary> | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 GroupBy => ArrayRef[Str|Undef] | ||
| 69 | |||
| 70 | Specifies a list of attributes to group the counts of noncompliant | ||
| 71 | resources by. If supplied, the counts are sorted by those attributes. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 MaxResults => Int | ||
| 76 | |||
| 77 | Specifies the maximum number of results to be returned in each page. A | ||
| 78 | query can return fewer than this maximum, even if there are more | ||
| 79 | results still to return. You should always check the C<PaginationToken> | ||
| 80 | response value to see if there are more results. You can specify a | ||
| 81 | minimum of 1 and a maximum value of 100. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 PaginationToken => Str | ||
| 86 | |||
| 87 | Specifies a C<PaginationToken> response value from a previous request | ||
| 88 | to indicate that you want the next page of results. Leave this | ||
| 89 | parameter empty in your initial request. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 RegionFilters => ArrayRef[Str|Undef] | ||
| 94 | |||
| 95 | Specifies a list of AWS Regions to limit the output by. If you use this | ||
| 96 | parameter, the count of returned noncompliant resources includes only | ||
| 97 | resources in the specified Regions. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 ResourceTypeFilters => ArrayRef[Str|Undef] | ||
| 102 | |||
| 103 | Specifies that you want the response to include information for only | ||
| 104 | resources of the specified types. The format of each resource type is | ||
| 105 | C<service[:resourceType]>. For example, specifying a resource type of | ||
| 106 | C<ec2> returns all Amazon EC2 resources (which includes EC2 instances). | ||
| 107 | Specifying a resource type of C<ec2:instance> returns only EC2 | ||
| 108 | instances. | ||
| 109 | |||
| 110 | The string for each service name and resource type is the same as that | ||
| 111 | embedded in a resource's Amazon Resource Name (ARN). Consult the I<AWS | ||
| 112 | General Reference> for the following: | ||
| 113 | |||
| 114 | =over | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | For a list of service name strings, see AWS Service Namespaces | ||
| 119 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces). | ||
| 120 | |||
| 121 | =item * | ||
| 122 | |||
| 123 | For resource type strings, see Example ARNs | ||
| 124 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax). | ||
| 125 | |||
| 126 | =item * | ||
| 127 | |||
| 128 | For more information about ARNs, see Amazon Resource Names (ARNs) and | ||
| 129 | AWS Service Namespaces | ||
| 130 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 131 | |||
| 132 | =back | ||
| 133 | |||
| 134 | You can specify multiple resource types by using a comma separated | ||
| 135 | array. The array can include up to 100 items. Note that the length | ||
| 136 | constraint requirement applies to each resource type filter. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 TagKeyFilters => ArrayRef[Str|Undef] | ||
| 141 | |||
| 142 | Specifies that you want the response to include information for only | ||
| 143 | resources that have tags with the specified tag keys. If you use this | ||
| 144 | parameter, the count of returned noncompliant resources includes only | ||
| 145 | resources that have the specified tag keys. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 TargetIdFilters => ArrayRef[Str|Undef] | ||
| 150 | |||
| 151 | Specifies target identifiers (usually, specific account IDs) to limit | ||
| 152 | the output by. If you use this parameter, the count of returned | ||
| 153 | noncompliant resources includes only resources with the specified | ||
| 154 | target IDs. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head1 SEE ALSO | ||
| 160 | |||
| 161 | This class forms part of L<Paws>, documenting arguments for method GetComplianceSummary in L<Paws::ResourceTagging> | ||
| 162 | |||
| 163 | =head1 BUGS and CONTRIBUTIONS | ||
| 164 | |||
| 165 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 166 | |||
| 167 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 168 | |||
| 169 | =cut | ||
| 170 |