Table of Contents
A low-level client representing Amazon WorkSpaces:
import boto3
client = boto3.client('workspaces')
These are the available methods:
Associates the specified IP access control group with the specified directory.
See also: AWS API Documentation
Request Syntax
response = client.associate_ip_groups(
DirectoryId='string',
GroupIds=[
'string',
]
)
[REQUIRED]
The identifier of the directory.
[REQUIRED]
The identifiers of one or more IP access control groups.
dict
Response Syntax
{}
Response Structure
Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
See also: AWS API Documentation
Request Syntax
response = client.authorize_ip_rules(
GroupId='string',
UserRules=[
{
'ipRule': 'string',
'ruleDesc': 'string'
},
]
)
[REQUIRED]
The identifier of the group.
[REQUIRED]
The rules to add to the group.
Describes a rule for an IP access control group.
The IP address range, in CIDR notation.
The description.
dict
Response Syntax
{}
Response Structure
Check if an operation can be paginated.
Copies the specified image from the specified Region to the current Region.
See also: AWS API Documentation
Request Syntax
response = client.copy_workspace_image(
Name='string',
Description='string',
SourceImageId='string',
SourceRegion='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the image.
[REQUIRED]
The identifier of the source image.
[REQUIRED]
The identifier of the source Region.
The tags for the image.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The identifier of the image.
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'
},
]
)
[REQUIRED]
The name of the group.
The rules to add to the group.
Describes a rule for an IP access control group.
The IP address range, in CIDR notation.
The description.
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'GroupId': 'string'
}
Response Structure
(dict) --
GroupId (string) --
The identifier of the group.
Creates the specified tags for the specified WorkSpaces resource.
See also: AWS API Documentation
Request Syntax
response = client.create_tags(
ResourceId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
[REQUIRED]
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{}
Response Structure
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'|'POWERPRO'|'GRAPHICSPRO'
},
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
)
[REQUIRED]
The WorkSpaces to create. You can specify up to 25 WorkSpaces.
Describes the information used to create a WorkSpace.
The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
The KMS key used to encrypt data stored on your WorkSpace.
Indicates whether the data stored on the user volume is encrypted.
Indicates whether the data stored on the root volume is encrypted.
The WorkSpace properties.
The running mode. For more information, see Manage the WorkSpace Running Mode .
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.
The size of the root volume.
The size of the user storage.
The compute type. For more information, see Amazon WorkSpaces Bundles .
The tags for the WorkSpace.
Describes a tag.
The key of the tag.
The value of the tag.
{
'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'|'POWERPRO'|'GRAPHICSPRO'
},
'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'|'ADMIN_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'|'POWERPRO'|'GRAPHICSPRO'
},
'ModificationStates': [
{
'Resource': 'ROOT_VOLUME'|'USER_VOLUME'|'COMPUTE_TYPE',
'State': 'UPDATE_INITIATED'|'UPDATE_IN_PROGRESS'
},
]
},
]
}
Response Structure
Information about the WorkSpaces that could not be created.
Describes a WorkSpace that cannot be created.
Information about the WorkSpace.
The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.
The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
The KMS key used to encrypt data stored on your WorkSpace.
Indicates whether the data stored on the user volume is encrypted.
Indicates whether the data stored on the root volume is encrypted.
The WorkSpace properties.
The running mode. For more information, see Manage the WorkSpace Running Mode .
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.
The size of the root volume.
The size of the user storage.
The compute type. For more information, see Amazon WorkSpaces Bundles .
The tags for the WorkSpace.
Describes a tag.
The key of the tag.
The value of the tag.
The error code that is returned if the WorkSpace cannot be created.
The text of the error message that is returned if the WorkSpace cannot be created.
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.
Describes a WorkSpace.
The identifier of the WorkSpace.
The identifier of the AWS Directory Service directory for the WorkSpace.
The user for the WorkSpace.
The IP address of the WorkSpace.
The operational state of the WorkSpace.
The identifier of the bundle used to create the WorkSpace.
The identifier of the subnet for the WorkSpace.
The text of the error message that is returned if the WorkSpace cannot be created.
The error code that is returned if the WorkSpace cannot be created.
The name of the WorkSpace, as seen by the operating system.
The KMS key used to encrypt data stored on your WorkSpace.
Indicates whether the data stored on the user volume is encrypted.
Indicates whether the data stored on the root volume is encrypted.
The properties of the WorkSpace.
The running mode. For more information, see Manage the WorkSpace Running Mode .
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.
The size of the root volume.
The size of the user storage.
The compute type. For more information, see Amazon WorkSpaces Bundles .
The modification states of the WorkSpace.
Describes a WorkSpace modification.
The resource.
The modification state.
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
See also: AWS API Documentation
Request Syntax
response = client.delete_ip_group(
GroupId='string'
)
[REQUIRED]
The identifier of the IP access control group.
{}
Response Structure
Deletes the specified tags from the specified WorkSpaces resource.
See also: AWS API Documentation
Request Syntax
response = client.delete_tags(
ResourceId='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
[REQUIRED]
The tag keys.
dict
Response Syntax
{}
Response Structure
Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and un-share the image if it is shared with other accounts.
See also: AWS API Documentation
Request Syntax
response = client.delete_workspace_image(
ImageId='string'
)
[REQUIRED]
The identifier of the image.
{}
Response Structure
Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.
See also: AWS API Documentation
Request Syntax
response = client.describe_account()
{
'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
'DedicatedTenancyManagementCidrRange': 'string'
}
Response Structure
The status of BYOL (whether BYOL is enabled or disabled).
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.
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
response = client.describe_account_modifications(
NextToken='string'
)
{
'AccountModifications': [
{
'ModificationState': 'PENDING'|'COMPLETED'|'FAILED',
'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
'DedicatedTenancyManagementCidrRange': 'string',
'StartTime': datetime(2015, 1, 1),
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
The list of modifications to the configuration of BYOL.
Describes a modification to the configuration of bring your own license (BYOL) for the specified account.
The state of the modification to the configuration of BYOL.
The status of BYOL (whether BYOL is being enabled or disabled).
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
The timestamp when the modification of the BYOL configuration was started.
The error code that is returned if the configuration of BYOL cannot be modified.
The text of the error message that is returned if the configuration of BYOL cannot be modified.
The token to use to retrieve the next set of results, or null if no more results are available.
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
See also: AWS API Documentation
Request Syntax
response = client.describe_client_properties(
ResourceIds=[
'string',
]
)
[REQUIRED]
The resource identifier, in the form of directory IDs.
{
'ClientPropertiesList': [
{
'ResourceId': 'string',
'ClientProperties': {
'ReconnectEnabled': 'ENABLED'|'DISABLED'
}
},
]
}
Response Structure
Information about the specified Amazon WorkSpaces clients.
Information about the Amazon WorkSpaces client.
The resource identifier, in the form of a directory ID.
Information about the Amazon WorkSpaces client.
Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
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
)
The identifiers of one or more IP access control groups.
dict
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 set of results, or null if no more results are available.
Describes the specified tags for the specified WorkSpaces resource.
See also: AWS API Documentation
Request Syntax
response = client.describe_tags(
ResourceId='string'
)
[REQUIRED]
The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.
{
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
The tags.
Describes a tag.
The key of the tag.
The value of the tag.
Retrieves a list that 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'
)
The identifiers of the bundles. You cannot combine this parameter with any other filter.
The owner of the bundles. You cannot combine this parameter with any other filter.
Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.
dict
Response Syntax
{
'Bundles': [
{
'BundleId': 'string',
'Name': 'string',
'Owner': 'string',
'Description': 'string',
'RootStorage': {
'Capacity': 'string'
},
'UserStorage': {
'Capacity': 'string'
},
'ComputeType': {
'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Bundles (list) --
Information about the bundles.
(dict) --
Describes 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.
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'
)
The identifiers of the directories. If the value is null, all directories are retrieved.
dict
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
},
'ipGroupIds': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Directories (list) --
Information about the directories.
(dict) --
Describes an AWS Directory Service directory that is used 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.
DnsIpAddresses (list) --
The IP addresses of the DNS servers for the directory.
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) --
Specifies 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) --
Specifies whether the WorkSpace user is an administrator on the WorkSpace.
ipGroupIds (list) --
The identifiers of the IP access control groups associated with the directory.
NextToken (string) --
The token to use to retrieve the next set of results, or null if no more results are available.
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
response = client.describe_workspace_images(
ImageIds=[
'string',
],
NextToken='string',
MaxResults=123
)
The identifier of the image.
dict
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.
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, 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'
)
The identifiers of the WorkSpaces. You cannot combine this parameter 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.
dict
Response Syntax
{
'Workspaces': [
{
'WorkspaceId': 'string',
'DirectoryId': 'string',
'UserName': 'string',
'IpAddress': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'MAINTENANCE'|'ADMIN_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'|'POWERPRO'|'GRAPHICSPRO'
},
'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) --
Describes 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) --
The text of the error message that is returned if the WorkSpace cannot be created.
ErrorCode (string) --
The error code that is returned if the WorkSpace cannot be created.
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) --
Describes 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 no more results are available.
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'
)
The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
dict
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 identifier 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 status 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 no more results are available.
Disassociates the specified IP access control group from the specified directory.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_ip_groups(
DirectoryId='string',
GroupIds=[
'string',
]
)
[REQUIRED]
The identifier of the directory.
[REQUIRED]
The identifiers of one or more IP access control groups.
dict
Response Syntax
{}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
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
response = client.import_workspace_image(
Ec2ImageId='string',
IngestionProcess='BYOL_REGULAR'|'BYOL_GRAPHICS'|'BYOL_GRAPHICSPRO',
ImageName='string',
ImageDescription='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The identifier of the EC2 image.
[REQUIRED]
The ingestion process to be used when importing the image.
[REQUIRED]
The name of the WorkSpace image.
[REQUIRED]
The description of the WorkSpace image.
The tags. Each WorkSpaces resource can have a maximum of 50 tags.
Describes a tag.
The key of the tag.
The value of the tag.
dict
Response Syntax
{
'ImageId': 'string'
}
Response Structure
(dict) --
ImageId (string) --
The identifier of the WorkSpace image.
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
response = client.list_available_management_cidr_ranges(
ManagementCidrRangeConstraint='string',
MaxResults=123,
NextToken='string'
)
[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).
dict
Response Syntax
{
'ManagementCidrRanges': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
ManagementCidrRanges (list) --
The list of available IP address ranges, specified as IPv4 CIDR blocks.
NextToken (string) --
The token to use to retrieve the next set of results, or null if no more results are available.
Modifies the configuration of bring your own license (BYOL) for the specified account.
See also: AWS API Documentation
Request Syntax
response = client.modify_account(
DedicatedTenancySupport='ENABLED',
DedicatedTenancyManagementCidrRange='string'
)
dict
Response Syntax
{}
Response Structure
Modifies the properties of the specified Amazon WorkSpaces clients.
See also: AWS API Documentation
Request Syntax
response = client.modify_client_properties(
ResourceId='string',
ClientProperties={
'ReconnectEnabled': 'ENABLED'|'DISABLED'
}
)
[REQUIRED]
The resource identifiers, in the form of directory IDs.
[REQUIRED]
Information about the Amazon WorkSpaces client.
Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.
dict
Response Syntax
{}
Response Structure
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'|'POWERPRO'|'GRAPHICSPRO'
}
)
[REQUIRED]
The identifier of the WorkSpace.
[REQUIRED]
The properties of the WorkSpace.
The running mode. For more information, see Manage the WorkSpace Running Mode .
The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60 minute intervals.
The size of the root volume.
The size of the user storage.
The compute type. For more information, see Amazon WorkSpaces Bundles .
dict
Response Syntax
{}
Response Structure
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE . WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.
See also: AWS API Documentation
Request Syntax
response = client.modify_workspace_state(
WorkspaceId='string',
WorkspaceState='AVAILABLE'|'ADMIN_MAINTENANCE'
)
[REQUIRED]
The identifier of the WorkSpace.
[REQUIRED]
The WorkSpace state.
dict
Response Syntax
{}
Response Structure
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY .
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'
},
]
)
[REQUIRED]
The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
Describes the information used to reboot a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpaces that could not be rebooted.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE , ERROR , or UNHEALTHY .
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'
},
]
)
[REQUIRED]
The WorkSpace to rebuild. You can specify a single WorkSpace.
Describes the information used to rebuild a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpace that could not be rebuilt.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
Removes one or more rules from the specified IP access control group.
See also: AWS API Documentation
Request Syntax
response = client.revoke_ip_rules(
GroupId='string',
UserRules=[
'string',
]
)
[REQUIRED]
The identifier of the group.
[REQUIRED]
The rules to remove from the group.
dict
Response Syntax
{}
Response Structure
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'
},
]
)
[REQUIRED]
The WorkSpaces to start. You can specify up to 25 WorkSpaces.
Information used to start a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpaces that could not be started.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
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'
},
]
)
[REQUIRED]
The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
Describes the information used to stop a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpaces that could not be stopped.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
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'
},
]
)
[REQUIRED]
The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
Describes the information used to terminate a WorkSpace.
The identifier of the WorkSpace.
{
'FailedRequests': [
{
'WorkspaceId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
Information about the WorkSpaces that could not be terminated.
Describes a WorkSpace that could not be rebooted. ( RebootWorkspaces ), rebuilt ( RebuildWorkspaces ), terminated ( TerminateWorkspaces ), started ( StartWorkspaces ), or stopped ( StopWorkspaces ).
The identifier of the WorkSpace.
The error code that is returned if the WorkSpace cannot be rebooted.
The text of the error message that is returned if the WorkSpace cannot be rebooted.
Replaces the current rules of the specified IP access control group with the specified rules.
See also: AWS API Documentation
Request Syntax
response = client.update_rules_of_ip_group(
GroupId='string',
UserRules=[
{
'ipRule': 'string',
'ruleDesc': 'string'
},
]
)
[REQUIRED]
The identifier of the group.
[REQUIRED]
One or more rules.
Describes a rule for an IP access control group.
The IP address range, in CIDR notation.
The description.
dict
Response Syntax
{}
Response Structure
The available paginators are:
paginator = client.get_paginator('describe_account_modifications')
Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_account_modifications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'AccountModifications': [
{
'ModificationState': 'PENDING'|'COMPLETED'|'FAILED',
'DedicatedTenancySupport': 'ENABLED'|'DISABLED',
'DedicatedTenancyManagementCidrRange': 'string',
'StartTime': datetime(2015, 1, 1),
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
],
}
Response Structure
The list of modifications to the configuration of BYOL.
Describes a modification to the configuration of bring your own license (BYOL) for the specified account.
The state of the modification to the configuration of BYOL.
The status of BYOL (whether BYOL is being enabled or disabled).
The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
The timestamp when the modification of the BYOL configuration was started.
The error code that is returned if the configuration of BYOL cannot be modified.
The text of the error message that is returned if the configuration of BYOL cannot be modified.
paginator = client.get_paginator('describe_ip_groups')
Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_ip_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
GroupIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The identifiers of one or more IP access control groups.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Result': [
{
'groupId': 'string',
'groupName': 'string',
'groupDesc': 'string',
'userRules': [
{
'ipRule': 'string',
'ruleDesc': '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.
paginator = client.get_paginator('describe_workspace_bundles')
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,
'StartingToken': 'string'
}
)
The identifiers of the bundles. You cannot combine this parameter with any other filter.
The owner of the bundles. You cannot combine this parameter with any other filter.
Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Bundles': [
{
'BundleId': 'string',
'Name': 'string',
'Owner': 'string',
'Description': 'string',
'RootStorage': {
'Capacity': 'string'
},
'UserStorage': {
'Capacity': 'string'
},
'ComputeType': {
'Name': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'
}
},
],
}
Response Structure
(dict) --
Bundles (list) --
Information about the bundles.
(dict) --
Describes 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.
paginator = client.get_paginator('describe_workspace_directories')
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,
'StartingToken': 'string'
}
)
The identifiers of the directories. If the value is null, all directories are retrieved.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
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
},
'ipGroupIds': [
'string',
]
},
],
}
Response Structure
(dict) --
Directories (list) --
Information about the directories.
(dict) --
Describes an AWS Directory Service directory that is used 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.
DnsIpAddresses (list) --
The IP addresses of the DNS servers for the directory.
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) --
Specifies 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) --
Specifies whether the WorkSpace user is an administrator on the WorkSpace.
ipGroupIds (list) --
The identifiers of the IP access control groups associated with the directory.
paginator = client.get_paginator('describe_workspace_images')
Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspace_images().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ImageIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The identifier of the image.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Images': [
{
'ImageId': 'string',
'Name': 'string',
'Description': 'string',
'OperatingSystem': {
'Type': 'WINDOWS'|'LINUX'
},
'State': 'AVAILABLE'|'PENDING'|'ERROR',
'RequiredTenancy': 'DEFAULT'|'DEDICATED',
'ErrorCode': 'string',
'ErrorMessage': '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.
paginator = client.get_paginator('describe_workspaces')
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'
}
)
The identifiers of the WorkSpaces. You cannot combine this parameter 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.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Workspaces': [
{
'WorkspaceId': 'string',
'DirectoryId': 'string',
'UserName': 'string',
'IpAddress': 'string',
'State': 'PENDING'|'AVAILABLE'|'IMPAIRED'|'UNHEALTHY'|'REBOOTING'|'STARTING'|'REBUILDING'|'MAINTENANCE'|'ADMIN_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'|'POWERPRO'|'GRAPHICSPRO'
},
'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) --
Describes 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) --
The text of the error message that is returned if the WorkSpace cannot be created.
ErrorCode (string) --
The error code that is returned if the WorkSpace cannot be created.
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) --
Describes a WorkSpace modification.
Resource (string) --
The resource.
State (string) --
The modification state.
paginator = client.get_paginator('describe_workspaces_connection_status')
Creates an iterator that will paginate through responses from WorkSpaces.Client.describe_workspaces_connection_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
WorkspaceIds=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
A dictionary that provides parameters to control pagination.
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.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'WorkspacesConnectionStatus': [
{
'WorkspaceId': 'string',
'ConnectionState': 'CONNECTED'|'DISCONNECTED'|'UNKNOWN',
'ConnectionStateCheckTimestamp': datetime(2015, 1, 1),
'LastKnownUserConnectionTimestamp': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
WorkspacesConnectionStatus (list) --
Information about the connection status of the WorkSpace.
(dict) --
Describes the connection status of a WorkSpace.
WorkspaceId (string) --
The identifier 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 status check.
LastKnownUserConnectionTimestamp (datetime) --
The timestamp of the last known user connection.
paginator = client.get_paginator('list_available_management_cidr_ranges')
Creates an iterator that will paginate through responses from WorkSpaces.Client.list_available_management_cidr_ranges().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ManagementCidrRangeConstraint='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[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).
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ManagementCidrRanges': [
'string',
],
}
Response Structure
(dict) --
ManagementCidrRanges (list) --
The list of available IP address ranges, specified as IPv4 CIDR blocks.