NAME

Paws::ResourceGroups::ListGroups - Arguments for method ListGroups on Paws::ResourceGroups

DESCRIPTION

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

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

SYNOPSIS

    my $resource-groups = Paws->service('ResourceGroups');
    my $ListGroupsOutput = $resource -groups->ListGroups(
      Filters => [
        {
          Name   => 'resource-type', # values: resource-type, configuration-type
          Values => [
            'MyGroupFilterValue', ...    # min: 1, max: 128
          ],    # min: 1, max: 5

        },
        ...
      ],    # OPTIONAL
      MaxResults => 1,                # OPTIONAL
      NextToken  => 'MyNextToken',    # OPTIONAL
    );

    # Results:
    my $GroupIdentifiers = $ListGroupsOutput->GroupIdentifiers;
    my $Groups           = $ListGroupsOutput->Groups;
    my $NextToken        = $ListGroupsOutput->NextToken;

    # Returns a L<Paws::ResourceGroups::ListGroupsOutput> 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/resource-groups/ListGroups

ATTRIBUTES

Filters => ArrayRef[Paws::ResourceGroups::GroupFilter]

Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

• resource-type - Filter the results to include only those of the specified resource types. Specify up to five resource types in the format AWS::ServiceCode::ResourceType . For example, AWS::EC2::Instance, or AWS::S3::Bucket.

• configuration-type - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:

  • AWS:EC2::CapacityReservationPool

  • AWS:EC2::HostManagement

MaxResults => Int

The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

NextToken => Str

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value provided by a previous call's NextToken response to indicate where the output should continue from.

SEE ALSO

This class forms part of Paws, documenting arguments for method ListGroups in Paws::ResourceGroups

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