WorkSpaces / Client / create_ip_group

create_ip_group#

WorkSpaces.Client.create_ip_group(**kwargs)#

Creates an IP access control group.

An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

There is a default IP access control group associated with your directory. If you don’t associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

See also: AWS API Documentation

Request Syntax

response = client.create_ip_group(
    GroupName='string',
    GroupDesc='string',
    UserRules=[
        {
            'ipRule': 'string',
            'ruleDesc': 'string'
        },
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • GroupName (string) –

    [REQUIRED]

    The name of the group.

  • GroupDesc (string) – The description of the group.

  • UserRules (list) –

    The rules to add to the group.

    • (dict) –

      Describes a rule for an IP access control group.

      • ipRule (string) –

        The IP address range, in CIDR notation.

      • ruleDesc (string) –

        The description.

  • Tags (list) –

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    • (dict) –

      Describes a tag.

      • Key (string) – [REQUIRED]

        The key of the tag.

      • Value (string) –

        The value of the tag.

Return type:

dict

Returns:

Response Syntax

{
    'GroupId': 'string'
}

Response Structure

  • (dict) –

    • GroupId (string) –

      The identifier of the group.

Exceptions

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.ResourceLimitExceededException

  • WorkSpaces.Client.exceptions.ResourceAlreadyExistsException

  • WorkSpaces.Client.exceptions.ResourceCreationFailedException

  • WorkSpaces.Client.exceptions.AccessDeniedException