WorkSpaces / Paginator / DescribeIpGroups

DescribeIpGroups

class WorkSpaces.Paginator.DescribeIpGroups

paginator = client.get_paginator('describe_ip_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_ip_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    GroupIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• GroupIds (list) –

  The identifiers of one or more IP access control groups.

  • (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

{
    'Result': [
        {
            'groupId': 'string',
            'groupName': 'string',
            'groupDesc': 'string',
            'userRules': [
                {
                    'ipRule': 'string',
                    'ruleDesc': 'string'
                },
            ]
        },
    ],

}

Response Structure

• (dict) –

  • Result (list) –

    Information about the IP access control groups.

    • (dict) –

      Describes an IP access control group.

      • groupId (string) –

        The identifier of the group.

      • groupName (string) –

        The name of the group.

      • groupDesc (string) –

        The description of the group.

      • userRules (list) –

        The rules.

        • (dict) –

          Describes a rule for an IP access control group.

          • ipRule (string) –

            The IP address range, in CIDR notation.

          • ruleDesc (string) –

            The description.