/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ResourceTagging::GetComplianceSummary

NAME

Paws::ResourceTagging::GetComplianceSummary - Arguments for method GetComplianceSummary on Paws::ResourceTagging

DESCRIPTION

This class represents the parameters used for calling the method GetComplianceSummary on the AWS Resource Groups Tagging API service. Use the attributes of this class as arguments to method GetComplianceSummary.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetComplianceSummary.

SYNOPSIS

my $tagging = Paws->service('ResourceTagging');
my $GetComplianceSummaryOutput = $tagging->GetComplianceSummary(
  GroupBy => [
    'TARGET_ID', ...    # values: TARGET_ID, REGION, RESOURCE_TYPE
  ],    # OPTIONAL
  MaxResults      => 1,                      # OPTIONAL
  PaginationToken => 'MyPaginationToken',    # OPTIONAL
  RegionFilters   => [
    'MyRegion', ...                          # min: 1, max: 256
  ],    # OPTIONAL
  ResourceTypeFilters => [
    'MyAmazonResourceType', ...    # max: 256
  ],    # OPTIONAL
  TagKeyFilters => [
    'MyTagKey', ...    # min: 1, max: 128
  ],    # OPTIONAL
  TargetIdFilters => [
    'MyTargetId', ...    # min: 6, max: 68
  ],    # OPTIONAL
);

# Results:
my $PaginationToken = $GetComplianceSummaryOutput->PaginationToken;
my $SummaryList     = $GetComplianceSummaryOutput->SummaryList;

# Returns a L<Paws::ResourceTagging::GetComplianceSummaryOutput> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/tagging/GetComplianceSummary

ATTRIBUTES

GroupBy => ArrayRef[Str|Undef]

Specifies a list of attributes to group the counts of noncompliant resources by. If supplied, the counts are sorted by those attributes.

MaxResults => Int

Specifies the maximum number of results to be returned in each page. A query can return fewer than this maximum, even if there are more results still to return. You should always check the PaginationToken response value to see if there are more results. You can specify a minimum of 1 and a maximum value of 100.

PaginationToken => Str

Specifies a PaginationToken response value from a previous request to indicate that you want the next page of results. Leave this parameter empty in your initial request.

RegionFilters => ArrayRef[Str|Undef]

Specifies a list of AWS Regions to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources in the specified Regions.

ResourceTypeFilters => ArrayRef[Str|Undef]

Specifies that you want the response to include information for only resources of the specified types. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:

  • For a list of service name strings, see AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces).

  • For resource type strings, see Example ARNs (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arns-syntax).

  • For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).

You can specify multiple resource types by using a comma separated array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

TagKeyFilters => ArrayRef[Str|Undef]

Specifies that you want the response to include information for only resources that have tags with the specified tag keys. If you use this parameter, the count of returned noncompliant resources includes only resources that have the specified tag keys.

TargetIdFilters => ArrayRef[Str|Undef]

Specifies target identifiers (usually, specific account IDs) to limit the output by. If you use this parameter, the count of returned noncompliant resources includes only resources with the specified target IDs.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetComplianceSummary in Paws::ResourceTagging

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues