Amazon WorkSpaces

2018/11/16 - Amazon WorkSpaces - 7 new api methods

Changes  Added new Bring Your Own License (BYOL) automation APIs. With the new APIs, you can list available management CIDR ranges for dedicated tenancy, enable your account for BYOL, describe BYOL status of your account, and import BYOL images. Added new APIs to also describe and delete WorkSpaces images.

ListAvailableManagementCidrRanges (new) Link ¶

Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL).

The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

See also: AWS API Documentation

Request Syntax

client.list_available_management_cidr_ranges(
    ManagementCidrRangeConstraint='string',
    MaxResults=123,
    NextToken='string'
)
type ManagementCidrRangeConstraint

string

param ManagementCidrRangeConstraint

[REQUIRED]

The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).

type MaxResults

integer

param MaxResults

The maximum number of items to return.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'ManagementCidrRanges': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ManagementCidrRanges (list) --

      The list of available IP address ranges, specified as IPv4 CIDR blocks.

      • (string) --

    • NextToken (string) --

      The token to use to retrieve the next set of results, or null if no more results are available.

ModifyAccount (new) Link ¶

Modifies the configuration of bring your own license (BYOL) for the specified account.

See also: AWS API Documentation

Request Syntax

client.modify_account(
    DedicatedTenancySupport='ENABLED',
    DedicatedTenancyManagementCidrRange='string'
)
type DedicatedTenancySupport

string

param DedicatedTenancySupport

The status of BYOL.

type DedicatedTenancyManagementCidrRange

string

param DedicatedTenancyManagementCidrRange

The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeWorkspaceImages (new) Link ¶

Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

See also: AWS API Documentation

Request Syntax

client.describe_workspace_images(
    ImageIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123
)
type ImageIds

list

param ImageIds

The identifier of the image.

  • (string) --

type NextToken

string

param NextToken

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

type MaxResults

integer

param MaxResults

The maximum number of items to return.

rtype

dict

returns

Response Syntax

{
    'Images': [
        {
            'ImageId': 'string',
            'Name': 'string',
            'Description': 'string',
            'OperatingSystem': {
                'Type': 'WINDOWS'|'LINUX'
            },
            'State': 'AVAILABLE'|'PENDING'|'ERROR',
            'RequiredTenancy': 'DEFAULT'|'DEDICATED',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Images (list) --

      Information about the images.

      • (dict) --

        Describes a WorkSpace image.

        • ImageId (string) --

          The identifier of the image.

        • Name (string) --

          The name of the image.

        • Description (string) --

          The description of the image.

        • OperatingSystem (dict) --

          The operating system that the image is running.

          • Type (string) --

            The operating system.

        • State (string) --

          The status of the image.

        • RequiredTenancy (string) --

          Specifies whether the image is running on dedicated hardware. When bring your own license (BYOL) is enabled, this value is set to DEDICATED.

        • ErrorCode (string) --

          The error code that is returned for the image.

        • ErrorMessage (string) --

          The text of the error message that is returned for the image.

    • NextToken (string) --

      The token to use to retrieve the next set of results, or null if no more results are available.

ImportWorkspaceImage (new) Link ¶

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'
)
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.

rtype

dict

returns

Response Syntax

{
    'ImageId': 'string'
}

Response Structure

  • (dict) --

    • ImageId (string) --

      The identifier of the WorkSpace image.

DescribeAccountModifications (new) Link ¶

Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.

See also: AWS API Documentation

Request Syntax

client.describe_account_modifications(
    NextToken='string'
)
type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'AccountModifications': [
        {
            'ModificationState': 'PENDING'|'COMPLETED'|'FAILED',
            'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
            'DedicatedTenancyManagementCidrRange': 'string',
            'StartTime': datetime(2015, 1, 1),
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AccountModifications (list) --

      The list of modifications to the configuration of BYOL.

      • (dict) --

        Describes a modification to the configuration of bring your own license (BYOL) for the specified account.

        • ModificationState (string) --

          The state of the modification to the configuration of BYOL.

        • DedicatedTenancySupport (string) --

          The status of BYOL (whether BYOL is being enabled or disabled).

        • DedicatedTenancyManagementCidrRange (string) --

          The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.

        • StartTime (datetime) --

          The timestamp when the modification of the BYOL configuration was started.

        • ErrorCode (string) --

          The error code that is returned if the configuration of BYOL cannot be modified.

        • ErrorMessage (string) --

          The text of the error message that is returned if the configuration of BYOL cannot be modified.

    • NextToken (string) --

      The token to use to retrieve the next set of results, or null if no more results are available.

DeleteWorkspaceImage (new) Link ¶

Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image.

See also: AWS API Documentation

Request Syntax

client.delete_workspace_image(
    ImageId='string'
)
type ImageId

string

param ImageId

[REQUIRED]

The identifier of the image.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeAccount (new) Link ¶

Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.

See also: AWS API Documentation

Request Syntax

client.describe_account()
rtype

dict

returns

Response Syntax

{
    'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
    'DedicatedTenancyManagementCidrRange': 'string'
}

Response Structure

  • (dict) --

    • DedicatedTenancySupport (string) --

      The status of BYOL (whether BYOL is enabled or disabled).

    • DedicatedTenancyManagementCidrRange (string) --

      The IP address range, specified as an IPv4 CIDR block, used for the management network interface.

      The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.