Amazon WorkSpaces

2019/03/28 - Amazon WorkSpaces - 2 updated api methods

Changes  Amazon WorkSpaces adds tagging support for WorkSpaces Images, WorkSpaces directories, WorkSpaces bundles and IP Access control groups.

CreateIpGroup (updated) Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}

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

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

string

param GroupName

[REQUIRED]

The name of the group.

type GroupDesc

string

param GroupDesc

The description of the group.

type UserRules

list

param UserRules

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.

type Tags

list

param Tags

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.

rtype

dict

returns

Response Syntax

{
    'GroupId': 'string'
}

Response Structure

  • (dict) --

    • GroupId (string) --

      The identifier of the group.

ImportWorkspaceImage (updated) Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.

See also: AWS API Documentation

Request Syntax

client.import_workspace_image(
    Ec2ImageId='string',
    IngestionProcess='BYOL_REGULAR'|'BYOL_GRAPHICS'|'BYOL_GRAPHICSPRO',
    ImageName='string',
    ImageDescription='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Ec2ImageId

string

param Ec2ImageId

[REQUIRED]

The identifier of the EC2 image.

type IngestionProcess

string

param IngestionProcess

[REQUIRED]

The ingestion process to be used when importing the image.

type ImageName

string

param ImageName

[REQUIRED]

The name of the WorkSpace image.

type ImageDescription

string

param ImageDescription

[REQUIRED]

The description of the WorkSpace image.

type Tags

list

param Tags

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.

rtype

dict

returns

Response Syntax

{
    'ImageId': 'string'
}

Response Structure

  • (dict) --

    • ImageId (string) --

      The identifier of the WorkSpace image.