WorkSpaces

Table of Contents

Client

class WorkSpaces.Client

A low-level client representing Amazon WorkSpaces:

import boto3

client = boto3.client('workspaces')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_tags(**kwargs)

Creates tags for the specified WorkSpace.

See also: AWS API Documentation

Request Syntax

response = client.create_tags(
    ResourceId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters
  • ResourceId (string) --

    [REQUIRED]

    The ID of the resource.

  • Tags (list) --

    [REQUIRED]

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

    • (dict) --

      Information about a tag.

      • Key (string) -- [REQUIRED]

        The key of the tag.

      • Value (string) --

        The value of the tag.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_workspaces(**kwargs)

Creates one or more WorkSpaces.

This operation is asynchronous and returns before the WorkSpaces are created.

See also: AWS API Documentation

Request Syntax

response = client.create_workspaces(
    Workspaces=[
        {
            'DirectoryId': 'string',
            'UserName': 'string',
            'BundleId': 'string',
            'VolumeEncryptionKey': 'string',
            'UserVolumeEncryptionEnabled': True|False,
            'RootVolumeEncryptionEnabled': True|False,
            'WorkspaceProperties': {
                'RunningMode': 'AUTO_STOP'|'ALWAYS_ON',
                'RunningModeAutoStopTimeoutInMinutes': 123,
                'RootVolumeSizeGib': 123,
                'UserVolumeSizeGib': 123,
                'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'
            },
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ]
)
Parameters
Workspaces (list) --

[REQUIRED]

Information about the WorkSpaces to create.

  • (dict) --

    Information used to create a WorkSpace.

    • DirectoryId (string) -- [REQUIRED]

      The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

    • UserName (string) -- [REQUIRED]

      The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.

    • BundleId (string) -- [REQUIRED]

      The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

    • VolumeEncryptionKey (string) --

      The KMS key used to encrypt data stored on your WorkSpace.

    • UserVolumeEncryptionEnabled (boolean) --

      Indicates whether the data stored on the user volume is encrypted.

    • RootVolumeEncryptionEnabled (boolean) --

      Indicates whether the data stored on the root volume is encrypted.

    • WorkspaceProperties (dict) --

      The WorkSpace properties.

      • RunningMode (string) --

        The running mode. For more information, see Manage the WorkSpace Running Mode .

      • RunningModeAutoStopTimeoutInMinutes (integer) --

        The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

      • RootVolumeSizeGib (integer) --

        The size of the root volume.

      • UserVolumeSizeGib (integer) --

        The size of the user storage.

      • ComputeTypeName (string) --

        The compute type. For more information, see Amazon WorkSpaces Bundles .

    • Tags (list) --

      The tags for the WorkSpace.

      • (dict) --

        Information about a tag.

        • Key (string) -- [REQUIRED]

          The key of the tag.

        • Value (string) --

          The value of the tag.

Return type
dict
Returns
Response Syntax
{
    'FailedRequests': [
        {
            'WorkspaceRequest': {
                'DirectoryId': 'string',
                'UserName': 'string',
                'BundleId': 'string',
                'VolumeEncryptionKey': 'string',
                'UserVolumeEncryptionEnabled': True|False,
                'RootVolumeEncryptionEnabled': True|False,
                'WorkspaceProperties': {
                    'RunningMode': 'AUTO_STOP'|'ALWAYS_ON',
                    'RunningModeAutoStopTimeoutInMinutes': 123,
                    'RootVolumeSizeGib': 123,
                    'UserVolumeSizeGib': 123,
                    'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'
                },
                'Tags': [
                    {
                        'Key': 'string',
                        'Value': 'string'
                    },
                ]
            },
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ],
    'PendingRequests': [
        {
            'WorkspaceId': 'string',
            'DirectoryId': 'string',
            'UserName': 'string',
            'IpAddress': 'string',
            'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
            'BundleId': 'string',
            'SubnetId': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string',
            'ComputerName': 'string',
            'VolumeEncryptionKey': 'string',
            'UserVolumeEncryptionEnabled': True|False,
            'RootVolumeEncryptionEnabled': True|False,
            'WorkspaceProperties': {
                'RunningMode': 'AUTO_STOP'|'ALWAYS_ON',
                'RunningModeAutoStopTimeoutInMinutes': 123,
                'RootVolumeSizeGib': 123,
                'UserVolumeSizeGib': 123,
                'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'
            },
            'ModificationStates': [
                {
                    'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
                    'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
                },
            ]
        },
    ]
}

Response Structure

  • (dict) --
    • FailedRequests (list) --

      Information about the WorkSpaces that could not be created.

      • (dict) --

        Information about a WorkSpace that could not be created.

        • WorkspaceRequest (dict) --

          Information about the WorkSpace.

          • DirectoryId (string) --

            The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

          • UserName (string) --

            The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.

          • BundleId (string) --

            The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

          • VolumeEncryptionKey (string) --

            The KMS key used to encrypt data stored on your WorkSpace.

          • UserVolumeEncryptionEnabled (boolean) --

            Indicates whether the data stored on the user volume is encrypted.

          • RootVolumeEncryptionEnabled (boolean) --

            Indicates whether the data stored on the root volume is encrypted.

          • WorkspaceProperties (dict) --

            The WorkSpace properties.

            • RunningMode (string) --

              The running mode. For more information, see Manage the WorkSpace Running Mode .

            • RunningModeAutoStopTimeoutInMinutes (integer) --

              The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

            • RootVolumeSizeGib (integer) --

              The size of the root volume.

            • UserVolumeSizeGib (integer) --

              The size of the user storage.

            • ComputeTypeName (string) --

              The compute type. For more information, see Amazon WorkSpaces Bundles .

          • Tags (list) --

            The tags for the WorkSpace.

            • (dict) --

              Information about a tag.

              • Key (string) --

                The key of the tag.

              • Value (string) --

                The value of the tag.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The textual error message.

    • PendingRequests (list) --

      Information about the WorkSpaces that were created.

      Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.

      • (dict) --

        Information about a WorkSpace.

        • WorkspaceId (string) --

          The identifier of the WorkSpace.

        • DirectoryId (string) --

          The identifier of the AWS Directory Service directory for the WorkSpace.

        • UserName (string) --

          The user for the WorkSpace.

        • IpAddress (string) --

          The IP address of the WorkSpace.

        • State (string) --

          The operational state of the WorkSpace.

        • BundleId (string) --

          The identifier of the bundle used to create the WorkSpace.

        • SubnetId (string) --

          The identifier of the subnet for the WorkSpace.

        • ErrorMessage (string) --

          If the WorkSpace could not be created, contains a textual error message that describes the failure.

        • ErrorCode (string) --

          If the WorkSpace could not be created, contains the error code.

        • ComputerName (string) --

          The name of the WorkSpace, as seen by the operating system.

        • VolumeEncryptionKey (string) --

          The KMS key used to encrypt data stored on your WorkSpace.

        • UserVolumeEncryptionEnabled (boolean) --

          Indicates whether the data stored on the user volume is encrypted.

        • RootVolumeEncryptionEnabled (boolean) --

          Indicates whether the data stored on the root volume is encrypted.

        • WorkspaceProperties (dict) --

          The properties of the WorkSpace.

          • RunningMode (string) --

            The running mode. For more information, see Manage the WorkSpace Running Mode .

          • RunningModeAutoStopTimeoutInMinutes (integer) --

            The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

          • RootVolumeSizeGib (integer) --

            The size of the root volume.

          • UserVolumeSizeGib (integer) --

            The size of the user storage.

          • ComputeTypeName (string) --

            The compute type. For more information, see Amazon WorkSpaces Bundles .

        • ModificationStates (list) --

          The modification states of the WorkSpace.

          • (dict) --

            Information about a WorkSpace modification.

            • Resource (string) --

              The resource.

            • State (string) --

              The modification state.

delete_tags(**kwargs)

Deletes the specified tags from a WorkSpace.

See also: AWS API Documentation

Request Syntax

response = client.delete_tags(
    ResourceId='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceId (string) --

    [REQUIRED]

    The ID of the resource.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

describe_tags(**kwargs)

Describes the tags for the specified WorkSpace.

See also: AWS API Documentation

Request Syntax

response = client.describe_tags(
    ResourceId='string'
)
Parameters
ResourceId (string) --

[REQUIRED]

The ID of the resource.

Return type
dict
Returns
Response Syntax
{
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • TagList (list) --

      The tags.

      • (dict) --

        Information about a tag.

        • Key (string) --

          The key of the tag.

        • Value (string) --

          The value of the tag.

describe_workspace_bundles(**kwargs)

Describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspace_bundles(
    BundleIds=[
        'string',
    ],
    Owner='string',
    NextToken='string'
)
Parameters
  • BundleIds (list) --

    The IDs of the bundles. This parameter cannot be combined with any other filter.

    • (string) --
  • Owner (string) --

    The owner of the bundles. This parameter cannot be combined with any other filter.

    Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.

  • NextToken (string) -- The token for the next set of results. (You received this token from a previous call.)
Return type

dict

Returns

Response Syntax

{
    'Bundles': [
        {
            'BundleId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'Description': 'string',
            'RootStorage': {
                'Capacity': 'string'
            },
            'UserStorage': {
                'Capacity': 'string'
            },
            'ComputeType': {
                'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Bundles (list) --

      Information about the bundles.

      • (dict) --

        Information about a WorkSpace bundle.

        • BundleId (string) --

          The bundle identifier.

        • Name (string) --

          The name of the bundle.

        • Owner (string) --

          The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.

        • Description (string) --

          A description.

        • RootStorage (dict) --

          The size of the root volume.

          • Capacity (string) --

            The size of the root volume.

        • UserStorage (dict) --

          The size of the user storage.

          • Capacity (string) --

            The size of the user storage.

        • ComputeType (dict) --

          The compute type. For more information, see Amazon WorkSpaces Bundles .

          • Name (string) --

            The compute type.

    • NextToken (string) --

      The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.

describe_workspace_directories(**kwargs)

Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspace_directories(
    DirectoryIds=[
        'string',
    ],
    NextToken='string'
)
Parameters
  • DirectoryIds (list) --

    The identifiers of the directories. If the value is null, all directories are retrieved.

    • (string) --
  • NextToken (string) -- The token for the next set of results. (You received this token from a previous call.)
Return type

dict

Returns

Response Syntax

{
    'Directories': [
        {
            'DirectoryId': 'string',
            'Alias': 'string',
            'DirectoryName': 'string',
            'RegistrationCode': 'string',
            'SubnetIds': [
                'string',
            ],
            'DnsIpAddresses': [
                'string',
            ],
            'CustomerUserName': 'string',
            'IamRoleId': 'string',
            'DirectoryType': 'SIMPLE_AD'|'AD_CONNECTOR',
            'WorkspaceSecurityGroupId': 'string',
            'State': 'REGISTERING'|'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ERROR',
            'WorkspaceCreationProperties': {
                'EnableWorkDocs': True|False,
                'EnableInternetAccess': True|False,
                'DefaultOu': 'string',
                'CustomSecurityGroupId': 'string',
                'UserEnabledAsLocalAdministrator': True|False
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Directories (list) --

      Information about the directories.

      • (dict) --

        Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

        • DirectoryId (string) --

          The directory identifier.

        • Alias (string) --

          The directory alias.

        • DirectoryName (string) --

          The name of the directory.

        • RegistrationCode (string) --

          The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

        • SubnetIds (list) --

          The identifiers of the subnets used with the directory.

          • (string) --
        • DnsIpAddresses (list) --

          The IP addresses of the DNS servers for the directory.

          • (string) --
        • CustomerUserName (string) --

          The user name for the service account.

        • IamRoleId (string) --

          The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

        • DirectoryType (string) --

          The directory type.

        • WorkspaceSecurityGroupId (string) --

          The identifier of the security group that is assigned to new WorkSpaces.

        • State (string) --

          The state of the directory's registration with Amazon WorkSpaces

        • WorkspaceCreationProperties (dict) --

          The default creation properties for all WorkSpaces in the directory.

          • EnableWorkDocs (boolean) --

            Indicates whether the directory is enabled for Amazon WorkDocs.

          • EnableInternetAccess (boolean) --

            The public IP address to attach to all WorkSpaces that are created or rebuilt.

          • DefaultOu (string) --

            The organizational unit (OU) in the directory for the WorkSpace machine accounts.

          • CustomSecurityGroupId (string) --

            The identifier of any security groups to apply to WorkSpaces when they are created.

          • UserEnabledAsLocalAdministrator (boolean) --

            Indicates whether the WorkSpace user is an administrator on the WorkSpace.

    • NextToken (string) --

      The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.

describe_workspaces(**kwargs)

Describes the specified WorkSpaces.

You can filter the results using bundle ID, directory ID, or owner, but you can specify only one filter at a time.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspaces(
    WorkspaceIds=[
        'string',
    ],
    DirectoryId='string',
    UserName='string',
    BundleId='string',
    Limit=123,
    NextToken='string'
)
Parameters
  • WorkspaceIds (list) --

    The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

    Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

    • (string) --
  • DirectoryId (string) -- The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName ). This parameter cannot be combined with any other filter.
  • UserName (string) -- The name of the directory user. You must specify this parameter with DirectoryId .
  • BundleId (string) -- The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.
  • Limit (integer) -- The maximum number of items to return.
  • NextToken (string) -- The token for the next set of results. (You received this token from a previous call.)
Return type

dict

Returns

Response Syntax

{
    'Workspaces': [
        {
            'WorkspaceId': 'string',
            'DirectoryId': 'string',
            'UserName': 'string',
            'IpAddress': 'string',
            'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
            'BundleId': 'string',
            'SubnetId': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string',
            'ComputerName': 'string',
            'VolumeEncryptionKey': 'string',
            'UserVolumeEncryptionEnabled': True|False,
            'RootVolumeEncryptionEnabled': True|False,
            'WorkspaceProperties': {
                'RunningMode': 'AUTO_STOP'|'ALWAYS_ON',
                'RunningModeAutoStopTimeoutInMinutes': 123,
                'RootVolumeSizeGib': 123,
                'UserVolumeSizeGib': 123,
                'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'
            },
            'ModificationStates': [
                {
                    'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
                    'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Workspaces (list) --

      Information about the WorkSpaces.

      Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

      • (dict) --

        Information about a WorkSpace.

        • WorkspaceId (string) --

          The identifier of the WorkSpace.

        • DirectoryId (string) --

          The identifier of the AWS Directory Service directory for the WorkSpace.

        • UserName (string) --

          The user for the WorkSpace.

        • IpAddress (string) --

          The IP address of the WorkSpace.

        • State (string) --

          The operational state of the WorkSpace.

        • BundleId (string) --

          The identifier of the bundle used to create the WorkSpace.

        • SubnetId (string) --

          The identifier of the subnet for the WorkSpace.

        • ErrorMessage (string) --

          If the WorkSpace could not be created, contains a textual error message that describes the failure.

        • ErrorCode (string) --

          If the WorkSpace could not be created, contains the error code.

        • ComputerName (string) --

          The name of the WorkSpace, as seen by the operating system.

        • VolumeEncryptionKey (string) --

          The KMS key used to encrypt data stored on your WorkSpace.

        • UserVolumeEncryptionEnabled (boolean) --

          Indicates whether the data stored on the user volume is encrypted.

        • RootVolumeEncryptionEnabled (boolean) --

          Indicates whether the data stored on the root volume is encrypted.

        • WorkspaceProperties (dict) --

          The properties of the WorkSpace.

          • RunningMode (string) --

            The running mode. For more information, see Manage the WorkSpace Running Mode .

          • RunningModeAutoStopTimeoutInMinutes (integer) --

            The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

          • RootVolumeSizeGib (integer) --

            The size of the root volume.

          • UserVolumeSizeGib (integer) --

            The size of the user storage.

          • ComputeTypeName (string) --

            The compute type. For more information, see Amazon WorkSpaces Bundles .

        • ModificationStates (list) --

          The modification states of the WorkSpace.

          • (dict) --

            Information about a WorkSpace modification.

            • Resource (string) --

              The resource.

            • State (string) --

              The modification state.

    • NextToken (string) --

      The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.

describe_workspaces_connection_status(**kwargs)

Describes the connection status of the specified WorkSpaces.

See also: AWS API Documentation

Request Syntax

response = client.describe_workspaces_connection_status(
    WorkspaceIds=[
        'string',
    ],
    NextToken='string'
)
Parameters
  • WorkspaceIds (list) --

    The identifiers of the WorkSpaces.

    • (string) --
  • NextToken (string) -- The token for the next set of results. (You received this token from a previous call.)
Return type

dict

Returns

Response Syntax

{
    'WorkspacesConnectionStatus': [
        {
            'WorkspaceId': 'string',
            'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'UNKNOWN',
            'ConnectionStateCheckTimestamp': datetime(2015, 1, 1),
            'LastKnownUserConnectionTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • WorkspacesConnectionStatus (list) --

      Information about the connection status of the WorkSpace.

      • (dict) --

        Describes the connection status of a WorkSpace.

        • WorkspaceId (string) --

          The ID of the WorkSpace.

        • ConnectionState (string) --

          The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.

        • ConnectionStateCheckTimestamp (datetime) --

          The timestamp of the connection state check.

        • LastKnownUserConnectionTimestamp (datetime) --

          The timestamp of the last known user connection.

    • NextToken (string) --

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

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_waiter(waiter_name)
modify_workspace_properties(**kwargs)

Modifies the specified WorkSpace properties.

See also: AWS API Documentation

Request Syntax

response = client.modify_workspace_properties(
    WorkspaceId='string',
    WorkspaceProperties={
        'RunningMode': 'AUTO_STOP'|'ALWAYS_ON',
        'RunningModeAutoStopTimeoutInMinutes': 123,
        'RootVolumeSizeGib': 123,
        'UserVolumeSizeGib': 123,
        'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'
    }
)
Parameters
  • WorkspaceId (string) --

    [REQUIRED]

    The ID of the WorkSpace.

  • WorkspaceProperties (dict) --

    [REQUIRED]

    The properties of the WorkSpace.

    • RunningMode (string) --

      The running mode. For more information, see Manage the WorkSpace Running Mode .

    • RunningModeAutoStopTimeoutInMinutes (integer) --

      The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

    • RootVolumeSizeGib (integer) --

      The size of the root volume.

    • UserVolumeSizeGib (integer) --

      The size of the user storage.

    • ComputeTypeName (string) --

      The compute type. For more information, see Amazon WorkSpaces Bundles .

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

reboot_workspaces(**kwargs)

Reboots the specified WorkSpaces.

You cannot reboot a WorkSpace unless its state is AVAILABLE , IMPAIRED , or INOPERABLE .

This operation is asynchronous and returns before the WorkSpaces have rebooted.

See also: AWS API Documentation

Request Syntax

response = client.reboot_workspaces(
    RebootWorkspaceRequests=[
        {
            'WorkspaceId': 'string'
        },
    ]
)
Parameters
RebootWorkspaceRequests (list) --

[REQUIRED]

The WorkSpaces to reboot.

  • (dict) --

    Information used to reboot a WorkSpace.

    • WorkspaceId (string) -- [REQUIRED]

      The identifier of the WorkSpace.

Return type
dict
Returns
Response Syntax
{
    'FailedRequests': [
        {
            'WorkspaceId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • FailedRequests (list) --

      Information about the WorkSpaces that could not be rebooted.

      • (dict) --

        Information about a WorkSpace that could not be rebooted ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).

        • WorkspaceId (string) --

          The identifier of the WorkSpace.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The textual error message.

rebuild_workspaces(**kwargs)

Rebuilds the specified WorkSpaces.

You cannot rebuild a WorkSpace unless its state is AVAILABLE or ERROR .

Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace .

This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

See also: AWS API Documentation

Request Syntax

response = client.rebuild_workspaces(
    RebuildWorkspaceRequests=[
        {
            'WorkspaceId': 'string'
        },
    ]
)
Parameters
RebuildWorkspaceRequests (list) --

[REQUIRED]

The WorkSpaces to rebuild.

  • (dict) --

    Information used to rebuild a WorkSpace.

    • WorkspaceId (string) -- [REQUIRED]

      The identifier of the WorkSpace.

Return type
dict
Returns
Response Syntax
{
    'FailedRequests': [
        {
            'WorkspaceId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • FailedRequests (list) --

      Information about the WorkSpaces that could not be rebuilt.

      • (dict) --

        Information about a WorkSpace that could not be rebooted ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).

        • WorkspaceId (string) --

          The identifier of the WorkSpace.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The textual error message.

start_workspaces(**kwargs)

Starts the specified WorkSpaces.

You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED .

See also: AWS API Documentation

Request Syntax

response = client.start_workspaces(
    StartWorkspaceRequests=[
        {
            'WorkspaceId': 'string'
        },
    ]
)
Parameters
StartWorkspaceRequests (list) --

[REQUIRED]

The WorkSpaces to start.

  • (dict) --

    Information used to start a WorkSpace.

    • WorkspaceId (string) --

      The ID of the WorkSpace.

Return type
dict
Returns
Response Syntax
{
    'FailedRequests': [
        {
            'WorkspaceId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • FailedRequests (list) --

      Information about the WorkSpaces that could not be started.

      • (dict) --

        Information about a WorkSpace that could not be rebooted ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).

        • WorkspaceId (string) --

          The identifier of the WorkSpace.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The textual error message.

stop_workspaces(**kwargs)

Stops the specified WorkSpaces.

You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE , IMPAIRED , UNHEALTHY , or ERROR .

See also: AWS API Documentation

Request Syntax

response = client.stop_workspaces(
    StopWorkspaceRequests=[
        {
            'WorkspaceId': 'string'
        },
    ]
)
Parameters
StopWorkspaceRequests (list) --

[REQUIRED]

The WorkSpaces to stop.

  • (dict) --

    Information used to stop a WorkSpace.

    • WorkspaceId (string) --

      The ID of the WorkSpace.

Return type
dict
Returns
Response Syntax
{
    'FailedRequests': [
        {
            'WorkspaceId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • FailedRequests (list) --

      Information about the WorkSpaces that could not be stopped.

      • (dict) --

        Information about a WorkSpace that could not be rebooted ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).

        • WorkspaceId (string) --

          The identifier of the WorkSpace.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The textual error message.

terminate_workspaces(**kwargs)

Terminates the specified WorkSpaces.

Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.

You can terminate a WorkSpace that is in any state except SUSPENDED .

This operation is asynchronous and returns before the WorkSpaces have been completely terminated.

See also: AWS API Documentation

Request Syntax

response = client.terminate_workspaces(
    TerminateWorkspaceRequests=[
        {
            'WorkspaceId': 'string'
        },
    ]
)
Parameters
TerminateWorkspaceRequests (list) --

[REQUIRED]

The WorkSpaces to terminate.

  • (dict) --

    Information used to terminate a WorkSpace.

    • WorkspaceId (string) -- [REQUIRED]

      The identifier of the WorkSpace.

Return type
dict
Returns
Response Syntax
{
    'FailedRequests': [
        {
            'WorkspaceId': 'string',
            'ErrorCode': 'string',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • FailedRequests (list) --

      Information about the WorkSpaces that could not be terminated.

      • (dict) --

        Information about a WorkSpace that could not be rebooted ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).

        • WorkspaceId (string) --

          The identifier of the WorkSpace.

        • ErrorCode (string) --

          The error code.

        • ErrorMessage (string) --

          The textual error message.

Paginators

The available paginators are:

class WorkSpaces.Paginator.DescribeWorkspaceBundles
paginator = client.get_paginator('describe_workspace_bundles')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    BundleIds=[
        'string',
    ],
    Owner='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • BundleIds (list) --

    The IDs of the bundles. This parameter cannot be combined with any other filter.

    • (string) --
  • Owner (string) --

    The owner of the bundles. This parameter cannot be combined with any other filter.

    Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.

  • 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

{
    'Bundles': [
        {
            'BundleId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'Description': 'string',
            'RootStorage': {
                'Capacity': 'string'
            },
            'UserStorage': {
                'Capacity': 'string'
            },
            'ComputeType': {
                'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'
            }
        },
    ],

}

Response Structure

  • (dict) --

    • Bundles (list) --

      Information about the bundles.

      • (dict) --

        Information about a WorkSpace bundle.

        • BundleId (string) --

          The bundle identifier.

        • Name (string) --

          The name of the bundle.

        • Owner (string) --

          The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.

        • Description (string) --

          A description.

        • RootStorage (dict) --

          The size of the root volume.

          • Capacity (string) --

            The size of the root volume.

        • UserStorage (dict) --

          The size of the user storage.

          • Capacity (string) --

            The size of the user storage.

        • ComputeType (dict) --

          The compute type. For more information, see Amazon WorkSpaces Bundles .

          • Name (string) --

            The compute type.

class WorkSpaces.Paginator.DescribeWorkspaceDirectories
paginator = client.get_paginator('describe_workspace_directories')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DirectoryIds=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DirectoryIds (list) --

    The identifiers of the directories. If the value is null, all directories are retrieved.

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

{
    'Directories': [
        {
            'DirectoryId': 'string',
            'Alias': 'string',
            'DirectoryName': 'string',
            'RegistrationCode': 'string',
            'SubnetIds': [
                'string',
            ],
            'DnsIpAddresses': [
                'string',
            ],
            'CustomerUserName': 'string',
            'IamRoleId': 'string',
            'DirectoryType': 'SIMPLE_AD'|'AD_CONNECTOR',
            'WorkspaceSecurityGroupId': 'string',
            'State': 'REGISTERING'|'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ERROR',
            'WorkspaceCreationProperties': {
                'EnableWorkDocs': True|False,
                'EnableInternetAccess': True|False,
                'DefaultOu': 'string',
                'CustomSecurityGroupId': 'string',
                'UserEnabledAsLocalAdministrator': True|False
            }
        },
    ],

}

Response Structure

  • (dict) --

    • Directories (list) --

      Information about the directories.

      • (dict) --

        Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

        • DirectoryId (string) --

          The directory identifier.

        • Alias (string) --

          The directory alias.

        • DirectoryName (string) --

          The name of the directory.

        • RegistrationCode (string) --

          The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

        • SubnetIds (list) --

          The identifiers of the subnets used with the directory.

          • (string) --
        • DnsIpAddresses (list) --

          The IP addresses of the DNS servers for the directory.

          • (string) --
        • CustomerUserName (string) --

          The user name for the service account.

        • IamRoleId (string) --

          The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

        • DirectoryType (string) --

          The directory type.

        • WorkspaceSecurityGroupId (string) --

          The identifier of the security group that is assigned to new WorkSpaces.

        • State (string) --

          The state of the directory's registration with Amazon WorkSpaces

        • WorkspaceCreationProperties (dict) --

          The default creation properties for all WorkSpaces in the directory.

          • EnableWorkDocs (boolean) --

            Indicates whether the directory is enabled for Amazon WorkDocs.

          • EnableInternetAccess (boolean) --

            The public IP address to attach to all WorkSpaces that are created or rebuilt.

          • DefaultOu (string) --

            The organizational unit (OU) in the directory for the WorkSpace machine accounts.

          • CustomSecurityGroupId (string) --

            The identifier of any security groups to apply to WorkSpaces when they are created.

          • UserEnabledAsLocalAdministrator (boolean) --

            Indicates whether the WorkSpace user is an administrator on the WorkSpace.

class WorkSpaces.Paginator.DescribeWorkspaces
paginator = client.get_paginator('describe_workspaces')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    WorkspaceIds=[
        'string',
    ],
    DirectoryId='string',
    UserName='string',
    BundleId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • WorkspaceIds (list) --

    The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

    Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

    • (string) --
  • DirectoryId (string) -- The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName ). This parameter cannot be combined with any other filter.
  • UserName (string) -- The name of the directory user. You must specify this parameter with DirectoryId .
  • BundleId (string) -- The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.
  • 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

{
    'Workspaces': [
        {
            'WorkspaceId': 'string',
            'DirectoryId': 'string',
            'UserName': 'string',
            'IpAddress': 'string',
            'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'MAINTENANCE'|'TERMINATING'|'TERMINATED'|'SUSPENDED'|'UPDATING'|'STOPPING'|'STOPPED'|'ERROR',
            'BundleId': 'string',
            'SubnetId': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string',
            'ComputerName': 'string',
            'VolumeEncryptionKey': 'string',
            'UserVolumeEncryptionEnabled': True|False,
            'RootVolumeEncryptionEnabled': True|False,
            'WorkspaceProperties': {
                'RunningMode': 'AUTO_STOP'|'ALWAYS_ON',
                'RunningModeAutoStopTimeoutInMinutes': 123,
                'RootVolumeSizeGib': 123,
                'UserVolumeSizeGib': 123,
                'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'
            },
            'ModificationStates': [
                {
                    'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
                    'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
                },
            ]
        },
    ],

}

Response Structure

  • (dict) --

    • Workspaces (list) --

      Information about the WorkSpaces.

      Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

      • (dict) --

        Information about a WorkSpace.

        • WorkspaceId (string) --

          The identifier of the WorkSpace.

        • DirectoryId (string) --

          The identifier of the AWS Directory Service directory for the WorkSpace.

        • UserName (string) --

          The user for the WorkSpace.

        • IpAddress (string) --

          The IP address of the WorkSpace.

        • State (string) --

          The operational state of the WorkSpace.

        • BundleId (string) --

          The identifier of the bundle used to create the WorkSpace.

        • SubnetId (string) --

          The identifier of the subnet for the WorkSpace.

        • ErrorMessage (string) --

          If the WorkSpace could not be created, contains a textual error message that describes the failure.

        • ErrorCode (string) --

          If the WorkSpace could not be created, contains the error code.

        • ComputerName (string) --

          The name of the WorkSpace, as seen by the operating system.

        • VolumeEncryptionKey (string) --

          The KMS key used to encrypt data stored on your WorkSpace.

        • UserVolumeEncryptionEnabled (boolean) --

          Indicates whether the data stored on the user volume is encrypted.

        • RootVolumeEncryptionEnabled (boolean) --

          Indicates whether the data stored on the root volume is encrypted.

        • WorkspaceProperties (dict) --

          The properties of the WorkSpace.

          • RunningMode (string) --

            The running mode. For more information, see Manage the WorkSpace Running Mode .

          • RunningModeAutoStopTimeoutInMinutes (integer) --

            The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.

          • RootVolumeSizeGib (integer) --

            The size of the root volume.

          • UserVolumeSizeGib (integer) --

            The size of the user storage.

          • ComputeTypeName (string) --

            The compute type. For more information, see Amazon WorkSpaces Bundles .

        • ModificationStates (list) --

          The modification states of the WorkSpace.

          • (dict) --

            Information about a WorkSpace modification.

            • Resource (string) --

              The resource.

            • State (string) --

              The modification state.