ResourceGroups / Paginator / ListGroups

ListGroups

class ResourceGroups.Paginator.ListGroups

paginator = client.get_paginator('list_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ResourceGroups.Client.list_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'Name': 'resource-type'|'configuration-type',
            'Values': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

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

  • resource-type - Filter the results to include only those resource groups that have the specified resource type in their ResourceTypeFilter. For example, AWS::EC2::Instance would return any resource group with a ResourceTypeFilter that includes AWS::EC2::Instance.

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

    • AWS::AppRegistry::Application

    • AWS::AppRegistry::ApplicationResourceGroups

    • AWS::CloudFormation::Stack

    • AWS::EC2::CapacityReservationPool

    • AWS::EC2::HostManagement

    • AWS::NetworkFirewall::RuleGroup

  • (dict) –

    A filter collection that you can use to restrict the results from a List operation to only those you want to include.

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.

      • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'GroupIdentifiers': [
        {
            'GroupName': 'string',
            'GroupArn': 'string'
        },
    ],
    'Groups': [
        {
            'GroupArn': 'string',
            'Name': 'string',
            'Description': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • GroupIdentifiers (list) –

    A list of GroupIdentifier objects. Each identifier is an object that contains both the Name and the GroupArn.

    • (dict) –

      The unique identifiers for a resource group.

      • GroupName (string) –

        The name of the resource group.

      • GroupArn (string) –

        The ARN of the resource group.

  • Groups (list) –

    Warning

    Deprecated - don’t use this field. Use the GroupIdentifiers response field instead.

    • (dict) –

      A resource group that contains Amazon Web Services resources. You can assign resources to the group by associating either of the following elements with the group:

      • ResourceQuery - Use a resource query to specify a set of tag keys and values. All resources in the same Amazon Web Services Region and Amazon Web Services account that have those keys with the same values are included in the group. You can add a resource query when you create the group, or later by using the PutGroupConfiguration operation.

      • GroupConfiguration - Use a service configuration to associate the group with an Amazon Web Services service. The configuration specifies which resource types can be included in the group.

      • GroupArn (string) –

        The ARN of the resource group.

      • Name (string) –

        The name of the resource group.

      • Description (string) –

        The description of the resource group.