WorkSpaces / Client / describe_ip_groups

describe_ip_groups#

WorkSpaces.Client.describe_ip_groups(**kwargs)#

Describes one or more of your IP access control groups.

See also: AWS API Documentation

Request Syntax

response = client.describe_ip_groups(
    GroupIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
Parameters:

  • GroupIds (list) –

    The identifiers of one or more IP access control groups.

    • (string) –

  • NextToken (string) – If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

  • MaxResults (integer) – The maximum number of items to return.

Return type:

dict

Returns:

Response Syntax

{
    'Result': [
        {
            'groupId': 'string',
            'groupName': 'string',
            'groupDesc': 'string',
            'userRules': [
                {
                    'ipRule': 'string',
                    'ruleDesc': 'string'
                },
            ]
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions