Amazon WorkSpaces

2024/06/27 - Amazon WorkSpaces - 9 new 3 updated api methods

Changes  Added support for WorkSpaces Pools.

UpdateWorkspacesPool (new) Link ¶

Updates the specified WorkSpaces pool.

See also: AWS API Documentation

Request Syntax

client.update_workspaces_pool(
    PoolId='string',
    Description='string',
    BundleId='string',
    DirectoryId='string',
    Capacity={
        'DesiredUserSessions': 123
    },
    ApplicationSettings={
        'Status': 'DISABLED'|'ENABLED',
        'SettingsGroup': 'string'
    },
    TimeoutSettings={
        'DisconnectTimeoutInSeconds': 123,
        'IdleDisconnectTimeoutInSeconds': 123,
        'MaxUserDurationInSeconds': 123
    }
)
type PoolId

string

param PoolId

[REQUIRED]

The identifier of the specified WorkSpaces pool to update.

type Description

string

param Description

Describes the specified WorkSpaces pool to update.

type BundleId

string

param BundleId

The identifier of the bundle.

type DirectoryId

string

param DirectoryId

The identifier of the directory.

type Capacity

dict

param Capacity

The desired capacity for the WorkSpaces pool.

  • DesiredUserSessions (integer) -- [REQUIRED]

    The desired number of user sessions for a multi-session pool. This is not allowed for single-session pools.

type ApplicationSettings

dict

param ApplicationSettings

The persistent application settings for users in the pool.

  • Status (string) -- [REQUIRED]

    Enables or disables persistent application settings for users during their pool sessions.

  • SettingsGroup (string) --

    The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.

type TimeoutSettings

dict

param TimeoutSettings

Indicates the timeout settings of the specified WorkSpaces pool.

  • DisconnectTimeoutInSeconds (integer) --

    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

  • IdleDisconnectTimeoutInSeconds (integer) --

    The amount of time in seconds a connection will stay active while idle.

  • MaxUserDurationInSeconds (integer) --

    Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

rtype

dict

returns

Response Syntax

{
    'WorkspacesPool': {
        'PoolId': 'string',
        'PoolArn': 'string',
        'CapacityStatus': {
            'AvailableUserSessions': 123,
            'DesiredUserSessions': 123,
            'ActualUserSessions': 123,
            'ActiveUserSessions': 123
        },
        'PoolName': 'string',
        'Description': 'string',
        'State': 'CREATING'|'DELETING'|'RUNNING'|'STARTING'|'STOPPED'|'STOPPING'|'UPDATING',
        'CreatedAt': datetime(2015, 1, 1),
        'BundleId': 'string',
        'DirectoryId': 'string',
        'Errors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_IS_MISSING'|'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'WORKSPACES_POOL_STOPPED'|'WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR'|'DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING'|'DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE'|'DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID'|'DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_INVALID'|'BUNDLE_NOT_FOUND'|'DIRECTORY_NOT_FOUND'|'INSUFFICIENT_PERMISSIONS_ERROR'|'DEFAULT_OU_IS_MISSING',
                'ErrorMessage': 'string'
            },
        ],
        'ApplicationSettings': {
            'Status': 'DISABLED'|'ENABLED',
            'SettingsGroup': 'string',
            'S3BucketName': 'string'
        },
        'TimeoutSettings': {
            'DisconnectTimeoutInSeconds': 123,
            'IdleDisconnectTimeoutInSeconds': 123,
            'MaxUserDurationInSeconds': 123
        }
    }
}

Response Structure

  • (dict) --

    • WorkspacesPool (dict) --

      Describes the specified WorkSpaces pool.

      • PoolId (string) --

        The identifier of a WorkSpaces pool.

      • PoolArn (string) --

        The Amazon Resource Name (ARN) for the WorkSpaces pool.

      • CapacityStatus (dict) --

        The capacity status for the pool

        • AvailableUserSessions (integer) --

          The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.

        • DesiredUserSessions (integer) --

          The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.

        • ActualUserSessions (integer) --

          The total number of session slots that are available for WorkSpaces pools.

        • ActiveUserSessions (integer) --

          The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.

      • PoolName (string) --

        The name of the pool,

      • Description (string) --

        The description of the pool.

      • State (string) --

        The current state of the pool.

      • CreatedAt (datetime) --

        The time the pool was created.

      • BundleId (string) --

        The identifier of the bundle used by the pool.

      • DirectoryId (string) --

        The identifier of the directory used by the pool.

      • Errors (list) --

        The pool errors.

        • (dict) --

          Describes a WorkSpaces pool error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

      • ApplicationSettings (dict) --

        The persistent application settings for users of the pool.

        • Status (string) --

          Specifies whether persistent application settings are enabled for users during their pool sessions.

        • SettingsGroup (string) --

          The path prefix for the S3 bucket where users’ persistent application settings are stored.

        • S3BucketName (string) --

          The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.

      • TimeoutSettings (dict) --

        The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

        • DisconnectTimeoutInSeconds (integer) --

          Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

        • IdleDisconnectTimeoutInSeconds (integer) --

          The amount of time in seconds a connection will stay active while idle.

        • MaxUserDurationInSeconds (integer) --

          Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

StartWorkspacesPool (new) Link ¶

Starts the specified WorkSpaces pool.

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

See also: AWS API Documentation

Request Syntax

client.start_workspaces_pool(
    PoolId='string'
)
type PoolId

string

param PoolId

[REQUIRED]

The identifier of the WorkSpaces pool.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeWorkspacesPools (new) Link ¶

Describes the specified WorkSpaces pool.

See also: AWS API Documentation

Request Syntax

client.describe_workspaces_pools(
    PoolIds=[
        'string',
    ],
    Filters=[
        {
            'Name': 'PoolName',
            'Values': [
                'string',
            ],
            'Operator': 'EQUALS'|'NOTEQUALS'|'CONTAINS'|'NOTCONTAINS'
        },
    ],
    Limit=123,
    NextToken='string'
)
type PoolIds

list

param PoolIds

The identifier of the WorkSpaces pool.

  • (string) --

type Filters

list

param Filters

The filter conditions for the WorkSpaces pool to return.

  • (dict) --

    Describes the filter conditions for the WorkSpaces pool to return.

    • Name (string) -- [REQUIRED]

      The name of the pool to filter.

    • Values (list) -- [REQUIRED]

      The values for filtering WorkSpaces pools.

      • (string) --

    • Operator (string) -- [REQUIRED]

      The operator values for filtering WorkSpaces pools.

type Limit

integer

param Limit

The maximum number of items to return.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'WorkspacesPools': [
        {
            'PoolId': 'string',
            'PoolArn': 'string',
            'CapacityStatus': {
                'AvailableUserSessions': 123,
                'DesiredUserSessions': 123,
                'ActualUserSessions': 123,
                'ActiveUserSessions': 123
            },
            'PoolName': 'string',
            'Description': 'string',
            'State': 'CREATING'|'DELETING'|'RUNNING'|'STARTING'|'STOPPED'|'STOPPING'|'UPDATING',
            'CreatedAt': datetime(2015, 1, 1),
            'BundleId': 'string',
            'DirectoryId': 'string',
            'Errors': [
                {
                    'ErrorCode': 'IAM_SERVICE_ROLE_IS_MISSING'|'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'WORKSPACES_POOL_STOPPED'|'WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR'|'DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING'|'DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE'|'DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID'|'DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_INVALID'|'BUNDLE_NOT_FOUND'|'DIRECTORY_NOT_FOUND'|'INSUFFICIENT_PERMISSIONS_ERROR'|'DEFAULT_OU_IS_MISSING',
                    'ErrorMessage': 'string'
                },
            ],
            'ApplicationSettings': {
                'Status': 'DISABLED'|'ENABLED',
                'SettingsGroup': 'string',
                'S3BucketName': 'string'
            },
            'TimeoutSettings': {
                'DisconnectTimeoutInSeconds': 123,
                'IdleDisconnectTimeoutInSeconds': 123,
                'MaxUserDurationInSeconds': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • WorkspacesPools (list) --

      Information about the WorkSpaces pools.

      • (dict) --

        Describes a WorkSpaces pool.

        • PoolId (string) --

          The identifier of a WorkSpaces pool.

        • PoolArn (string) --

          The Amazon Resource Name (ARN) for the WorkSpaces pool.

        • CapacityStatus (dict) --

          The capacity status for the pool

          • AvailableUserSessions (integer) --

            The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.

          • DesiredUserSessions (integer) --

            The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.

          • ActualUserSessions (integer) --

            The total number of session slots that are available for WorkSpaces pools.

          • ActiveUserSessions (integer) --

            The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.

        • PoolName (string) --

          The name of the pool,

        • Description (string) --

          The description of the pool.

        • State (string) --

          The current state of the pool.

        • CreatedAt (datetime) --

          The time the pool was created.

        • BundleId (string) --

          The identifier of the bundle used by the pool.

        • DirectoryId (string) --

          The identifier of the directory used by the pool.

        • Errors (list) --

          The pool errors.

          • (dict) --

            Describes a WorkSpaces pool error.

            • ErrorCode (string) --

              The error code.

            • ErrorMessage (string) --

              The error message.

        • ApplicationSettings (dict) --

          The persistent application settings for users of the pool.

          • Status (string) --

            Specifies whether persistent application settings are enabled for users during their pool sessions.

          • SettingsGroup (string) --

            The path prefix for the S3 bucket where users’ persistent application settings are stored.

          • S3BucketName (string) --

            The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.

        • TimeoutSettings (dict) --

          The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

          • DisconnectTimeoutInSeconds (integer) --

            Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

          • IdleDisconnectTimeoutInSeconds (integer) --

            The amount of time in seconds a connection will stay active while idle.

          • MaxUserDurationInSeconds (integer) --

            Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

    • NextToken (string) --

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

ModifyStreamingProperties (new) Link ¶

Modifies the specified streaming properties.

See also: AWS API Documentation

Request Syntax

client.modify_streaming_properties(
    ResourceId='string',
    StreamingProperties={
        'StreamingExperiencePreferredProtocol': 'TCP'|'UDP',
        'UserSettings': [
            {
                'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'PRINTING_TO_LOCAL_DEVICE'|'SMART_CARD',
                'Permission': 'ENABLED'|'DISABLED',
                'MaximumLength': 123
            },
        ],
        'StorageConnectors': [
            {
                'ConnectorType': 'HOME_FOLDER',
                'Status': 'ENABLED'|'DISABLED'
            },
        ]
    }
)
type ResourceId

string

param ResourceId

[REQUIRED]

The identifier of the resource.

type StreamingProperties

dict

param StreamingProperties

The streaming properties to configure.

  • StreamingExperiencePreferredProtocol (string) --

    Indicates the type of preferred protocol for the streaming experience.

  • UserSettings (list) --

    Indicates the permission settings asscoiated with the user.

    • (dict) --

      Information about the user's permission settings.

      • Action (string) -- [REQUIRED]

        Indicates the type of action.

      • Permission (string) -- [REQUIRED]

        Indicates if the setting is enabled or disabled.

      • MaximumLength (integer) --

        Indicates the maximum character length for the specified user setting.

  • StorageConnectors (list) --

    Indicates the storage connector used

    • (dict) --

      Describes the storage connector.

      • ConnectorType (string) -- [REQUIRED]

        The type of connector used to save user files.

      • Status (string) -- [REQUIRED]

        Indicates if the storage connetor is enabled or disabled.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

CreateWorkspacesPool (new) Link ¶

Creates a pool of WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.create_workspaces_pool(
    PoolName='string',
    Description='string',
    BundleId='string',
    DirectoryId='string',
    Capacity={
        'DesiredUserSessions': 123
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    ApplicationSettings={
        'Status': 'DISABLED'|'ENABLED',
        'SettingsGroup': 'string'
    },
    TimeoutSettings={
        'DisconnectTimeoutInSeconds': 123,
        'IdleDisconnectTimeoutInSeconds': 123,
        'MaxUserDurationInSeconds': 123
    }
)
type PoolName

string

param PoolName

[REQUIRED]

The name of the WorkSpaces pool.

type Description

string

param Description

[REQUIRED]

The WorkSpaces pool description.

type BundleId

string

param BundleId

[REQUIRED]

The identifier of the bundle for the WorkSpaces pool.

type DirectoryId

string

param DirectoryId

[REQUIRED]

The identifier of the directory for the WorkSpaces pool.

type Capacity

dict

param Capacity

[REQUIRED]

The user capacity of the WorkSpaces pool.

  • DesiredUserSessions (integer) -- [REQUIRED]

    The desired number of user sessions for a multi-session pool. This is not allowed for single-session pools.

type Tags

list

param Tags

The tags for the WorkSpaces pool.

  • (dict) --

    Describes a tag.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) --

      The value of the tag.

type ApplicationSettings

dict

param ApplicationSettings

Indicates the application settings of the WorkSpaces pool.

  • Status (string) -- [REQUIRED]

    Enables or disables persistent application settings for users during their pool sessions.

  • SettingsGroup (string) --

    The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple pools by specifying the same settings group for each pool.

type TimeoutSettings

dict

param TimeoutSettings

Indicates the timeout settings of the WorkSpaces pool.

  • DisconnectTimeoutInSeconds (integer) --

    Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

  • IdleDisconnectTimeoutInSeconds (integer) --

    The amount of time in seconds a connection will stay active while idle.

  • MaxUserDurationInSeconds (integer) --

    Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

rtype

dict

returns

Response Syntax

{
    'WorkspacesPool': {
        'PoolId': 'string',
        'PoolArn': 'string',
        'CapacityStatus': {
            'AvailableUserSessions': 123,
            'DesiredUserSessions': 123,
            'ActualUserSessions': 123,
            'ActiveUserSessions': 123
        },
        'PoolName': 'string',
        'Description': 'string',
        'State': 'CREATING'|'DELETING'|'RUNNING'|'STARTING'|'STOPPED'|'STOPPING'|'UPDATING',
        'CreatedAt': datetime(2015, 1, 1),
        'BundleId': 'string',
        'DirectoryId': 'string',
        'Errors': [
            {
                'ErrorCode': 'IAM_SERVICE_ROLE_IS_MISSING'|'IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION'|'IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION'|'NETWORK_INTERFACE_LIMIT_EXCEEDED'|'INTERNAL_SERVICE_ERROR'|'MACHINE_ROLE_IS_MISSING'|'STS_DISABLED_IN_REGION'|'SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION'|'SUBNET_NOT_FOUND'|'IMAGE_NOT_FOUND'|'INVALID_SUBNET_CONFIGURATION'|'SECURITY_GROUPS_NOT_FOUND'|'IGW_NOT_ATTACHED'|'IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION'|'WORKSPACES_POOL_STOPPED'|'WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE'|'DOMAIN_JOIN_ERROR_FILE_NOT_FOUND'|'DOMAIN_JOIN_ERROR_ACCESS_DENIED'|'DOMAIN_JOIN_ERROR_LOGON_FAILURE'|'DOMAIN_JOIN_ERROR_INVALID_PARAMETER'|'DOMAIN_JOIN_ERROR_MORE_DATA'|'DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN'|'DOMAIN_JOIN_ERROR_NOT_SUPPORTED'|'DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME'|'DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED'|'DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED'|'DOMAIN_JOIN_NERR_PASSWORD_EXPIRED'|'DOMAIN_JOIN_INTERNAL_SERVICE_ERROR'|'DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING'|'DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE'|'DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID'|'DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND'|'DOMAIN_JOIN_ERROR_SECRET_INVALID'|'BUNDLE_NOT_FOUND'|'DIRECTORY_NOT_FOUND'|'INSUFFICIENT_PERMISSIONS_ERROR'|'DEFAULT_OU_IS_MISSING',
                'ErrorMessage': 'string'
            },
        ],
        'ApplicationSettings': {
            'Status': 'DISABLED'|'ENABLED',
            'SettingsGroup': 'string',
            'S3BucketName': 'string'
        },
        'TimeoutSettings': {
            'DisconnectTimeoutInSeconds': 123,
            'IdleDisconnectTimeoutInSeconds': 123,
            'MaxUserDurationInSeconds': 123
        }
    }
}

Response Structure

  • (dict) --

    • WorkspacesPool (dict) --

      Indicates the WorkSpaces pool to create.

      • PoolId (string) --

        The identifier of a WorkSpaces pool.

      • PoolArn (string) --

        The Amazon Resource Name (ARN) for the WorkSpaces pool.

      • CapacityStatus (dict) --

        The capacity status for the pool

        • AvailableUserSessions (integer) --

          The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.

        • DesiredUserSessions (integer) --

          The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your pool can support in a steady state.

        • ActualUserSessions (integer) --

          The total number of session slots that are available for WorkSpaces pools.

        • ActiveUserSessions (integer) --

          The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.

      • PoolName (string) --

        The name of the pool,

      • Description (string) --

        The description of the pool.

      • State (string) --

        The current state of the pool.

      • CreatedAt (datetime) --

        The time the pool was created.

      • BundleId (string) --

        The identifier of the bundle used by the pool.

      • DirectoryId (string) --

        The identifier of the directory used by the pool.

      • Errors (list) --

        The pool errors.

        • (dict) --

          Describes a WorkSpaces pool error.

          • ErrorCode (string) --

            The error code.

          • ErrorMessage (string) --

            The error message.

      • ApplicationSettings (dict) --

        The persistent application settings for users of the pool.

        • Status (string) --

          Specifies whether persistent application settings are enabled for users during their pool sessions.

        • SettingsGroup (string) --

          The path prefix for the S3 bucket where users’ persistent application settings are stored.

        • S3BucketName (string) --

          The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an Amazon Web Services Region, an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.

      • TimeoutSettings (dict) --

        The amount of time that a pool session remains active after users disconnect. If they try to reconnect to the pool session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new pool instance.

        • DisconnectTimeoutInSeconds (integer) --

          Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

        • IdleDisconnectTimeoutInSeconds (integer) --

          The amount of time in seconds a connection will stay active while idle.

        • MaxUserDurationInSeconds (integer) --

          Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

TerminateWorkspacesPoolSession (new) Link ¶

Terminates the WorkSpaces pool session.

See also: AWS API Documentation

Request Syntax

client.terminate_workspaces_pool_session(
    SessionId='string'
)
type SessionId

string

param SessionId

[REQUIRED]

The identifier of the WorkSpaces pool session.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

StopWorkspacesPool (new) Link ¶

Stops the specifiedWorkSpaces pool.

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

See also: AWS API Documentation

Request Syntax

client.stop_workspaces_pool(
    PoolId='string'
)
type PoolId

string

param PoolId

[REQUIRED]

The identifier of the WorkSpaces pool.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeWorkspacesPoolSessions (new) Link ¶

Retrieves a list that describes the streaming sessions for a specified WorkSpaces pool.

See also: AWS API Documentation

Request Syntax

client.describe_workspaces_pool_sessions(
    PoolId='string',
    UserId='string',
    Limit=123,
    NextToken='string'
)
type PoolId

string

param PoolId

[REQUIRED]

The identifier of the WorkSpaces pool.

type UserId

string

param UserId

The identifier of the user.

type Limit

integer

param Limit

The maximum number of items to return.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'Sessions': [
        {
            'AuthenticationType': 'SAML',
            'ConnectionState': 'CONNECTED'|'NOT_CONNECTED',
            'SessionId': 'string',
            'InstanceId': 'string',
            'PoolId': 'string',
            'ExpirationTime': datetime(2015, 1, 1),
            'NetworkAccessConfiguration': {
                'EniPrivateIpAddress': 'string',
                'EniId': 'string'
            },
            'StartTime': datetime(2015, 1, 1),
            'UserId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Sessions (list) --

      Describes the WorkSpaces pool sessions.

      • (dict) --

        Describes a WorkSpaces pool session.

        • AuthenticationType (string) --

          The authentication method. The user is authenticated using a WorkSpaces pool URL (API) or SAML 2.0 federation (SAML).

        • ConnectionState (string) --

          Specifies whether a user is connected to the pool session.

        • SessionId (string) --

          The identifier of the session.

        • InstanceId (string) --

          The identifier for the instance hosting the session.

        • PoolId (string) --

          The identifier of the pool.

        • ExpirationTime (datetime) --

          The time that the pool session ended.

        • NetworkAccessConfiguration (dict) --

          Describes the network details of the pool.

          • EniPrivateIpAddress (string) --

            The private IP address of the elastic network interface that is attached to instances in your VPC.

          • EniId (string) --

            The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.

        • StartTime (datetime) --

          The time that the pool sission started.

        • UserId (string) --

          The identifier of the user.

    • NextToken (string) --

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

TerminateWorkspacesPool (new) Link ¶

Terminates the specified WorkSpaces pool.

See also: AWS API Documentation

Request Syntax

client.terminate_workspaces_pool(
    PoolId='string'
)
type PoolId

string

param PoolId

[REQUIRED]

The identifier of the WorkSpaces pool.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

DescribeWorkspaceDirectories (updated) Link ¶
Changes (request, response)
Request
{'WorkspaceDirectoryNames': ['string']}
Response
{'Directories': {'ActiveDirectoryConfig': {'DomainName': 'string',
                                           'ServiceAccountSecretArn': 'string'},
                 'DirectoryType': {'CUSTOMER_MANAGED'},
                 'ErrorMessage': 'string',
                 'StreamingProperties': {'StorageConnectors': [{'ConnectorType': 'HOME_FOLDER',
                                                                'Status': 'ENABLED '
                                                                          '| '
                                                                          'DISABLED'}],
                                         'StreamingExperiencePreferredProtocol': 'TCP '
                                                                                 '| '
                                                                                 'UDP',
                                         'UserSettings': [{'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE '
                                                                     '| '
                                                                     'CLIPBOARD_COPY_TO_LOCAL_DEVICE '
                                                                     '| '
                                                                     'PRINTING_TO_LOCAL_DEVICE '
                                                                     '| '
                                                                     'SMART_CARD',
                                                           'MaximumLength': 'integer',
                                                           'Permission': 'ENABLED '
                                                                         '| '
                                                                         'DISABLED'}]},
                 'UserIdentityType': 'CUSTOMER_MANAGED | AWS_DIRECTORY_SERVICE',
                 'WorkspaceCreationProperties': {'InstanceIamRoleArn': 'string'},
                 'WorkspaceDirectoryDescription': 'string',
                 'WorkspaceDirectoryName': 'string',
                 'WorkspaceType': 'PERSONAL | POOLS'}}

Describes the available directories that are registered with Amazon WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.describe_workspace_directories(
    DirectoryIds=[
        'string',
    ],
    WorkspaceDirectoryNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)
type DirectoryIds

list

param DirectoryIds

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

  • (string) --

type WorkspaceDirectoryNames

list

param WorkspaceDirectoryNames

The names of the WorkSpace directories.

  • (string) --

type Limit

integer

param Limit

The maximum number of directories to return.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'Directories': [
        {
            'DirectoryId': 'string',
            'Alias': 'string',
            'DirectoryName': 'string',
            'RegistrationCode': 'string',
            'SubnetIds': [
                'string',
            ],
            'DnsIpAddresses': [
                'string',
            ],
            'CustomerUserName': 'string',
            'IamRoleId': 'string',
            'DirectoryType': 'SIMPLE_AD'|'AD_CONNECTOR'|'CUSTOMER_MANAGED',
            'WorkspaceSecurityGroupId': 'string',
            'State': 'REGISTERING'|'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ERROR',
            'WorkspaceCreationProperties': {
                'EnableWorkDocs': True|False,
                'EnableInternetAccess': True|False,
                'DefaultOu': 'string',
                'CustomSecurityGroupId': 'string',
                'UserEnabledAsLocalAdministrator': True|False,
                'EnableMaintenanceMode': True|False,
                'InstanceIamRoleArn': 'string'
            },
            'ipGroupIds': [
                'string',
            ],
            'WorkspaceAccessProperties': {
                'DeviceTypeWindows': 'ALLOW'|'DENY',
                'DeviceTypeOsx': 'ALLOW'|'DENY',
                'DeviceTypeWeb': 'ALLOW'|'DENY',
                'DeviceTypeIos': 'ALLOW'|'DENY',
                'DeviceTypeAndroid': 'ALLOW'|'DENY',
                'DeviceTypeChromeOs': 'ALLOW'|'DENY',
                'DeviceTypeZeroClient': 'ALLOW'|'DENY',
                'DeviceTypeLinux': 'ALLOW'|'DENY'
            },
            'Tenancy': 'DEDICATED'|'SHARED',
            'SelfservicePermissions': {
                'RestartWorkspace': 'ENABLED'|'DISABLED',
                'IncreaseVolumeSize': 'ENABLED'|'DISABLED',
                'ChangeComputeType': 'ENABLED'|'DISABLED',
                'SwitchRunningMode': 'ENABLED'|'DISABLED',
                'RebuildWorkspace': 'ENABLED'|'DISABLED'
            },
            'SamlProperties': {
                'Status': 'DISABLED'|'ENABLED'|'ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK',
                'UserAccessUrl': 'string',
                'RelayStateParameterName': 'string'
            },
            'CertificateBasedAuthProperties': {
                'Status': 'DISABLED'|'ENABLED',
                'CertificateAuthorityArn': 'string'
            },
            'WorkspaceDirectoryName': 'string',
            'WorkspaceDirectoryDescription': 'string',
            'UserIdentityType': 'CUSTOMER_MANAGED'|'AWS_DIRECTORY_SERVICE',
            'WorkspaceType': 'PERSONAL'|'POOLS',
            'ActiveDirectoryConfig': {
                'DomainName': 'string',
                'ServiceAccountSecretArn': 'string'
            },
            'StreamingProperties': {
                'StreamingExperiencePreferredProtocol': 'TCP'|'UDP',
                'UserSettings': [
                    {
                        'Action': 'CLIPBOARD_COPY_FROM_LOCAL_DEVICE'|'CLIPBOARD_COPY_TO_LOCAL_DEVICE'|'PRINTING_TO_LOCAL_DEVICE'|'SMART_CARD',
                        'Permission': 'ENABLED'|'DISABLED',
                        'MaximumLength': 123
                    },
                ],
                'StorageConnectors': [
                    {
                        'ConnectorType': 'HOME_FOLDER',
                        'Status': 'ENABLED'|'DISABLED'
                    },
                ]
            },
            'ErrorMessage': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Directories (list) --

      Information about the directories.

      • (dict) --

        Describes a 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.

          • (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. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.

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

            Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

          • DefaultOu (string) --

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

          • CustomSecurityGroupId (string) --

            The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.

          • UserEnabledAsLocalAdministrator (boolean) --

            Specifies whether WorkSpace users are local administrators on their WorkSpaces.

          • EnableMaintenanceMode (boolean) --

            Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see WorkSpace Maintenance.

          • InstanceIamRoleArn (string) --

            Indicates the IAM role ARN of the instance.

        • ipGroupIds (list) --

          The identifiers of the IP access control groups associated with the directory.

          • (string) --

        • WorkspaceAccessProperties (dict) --

          The devices and operating systems that users can use to access WorkSpaces.

          • DeviceTypeWindows (string) --

            Indicates whether users can use Windows clients to access their WorkSpaces.

          • DeviceTypeOsx (string) --

            Indicates whether users can use macOS clients to access their WorkSpaces.

          • DeviceTypeWeb (string) --

            Indicates whether users can access their WorkSpaces through a web browser.

          • DeviceTypeIos (string) --

            Indicates whether users can use iOS devices to access their WorkSpaces.

          • DeviceTypeAndroid (string) --

            Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.

          • DeviceTypeChromeOs (string) --

            Indicates whether users can use Chromebooks to access their WorkSpaces.

          • DeviceTypeZeroClient (string) --

            Indicates whether users can use zero client devices to access their WorkSpaces.

          • DeviceTypeLinux (string) --

            Indicates whether users can use Linux clients to access their WorkSpaces.

        • Tenancy (string) --

          Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED . For more information, see Bring Your Own Windows Desktop Images.

        • SelfservicePermissions (dict) --

          The default self-service permissions for WorkSpaces in the directory.

          • RestartWorkspace (string) --

            Specifies whether users can restart their WorkSpace.

          • IncreaseVolumeSize (string) --

            Specifies whether users can increase the volume size of the drives on their WorkSpace.

          • ChangeComputeType (string) --

            Specifies whether users can change the compute type (bundle) for their WorkSpace.

          • SwitchRunningMode (string) --

            Specifies whether users can switch the running mode of their WorkSpace.

          • RebuildWorkspace (string) --

            Specifies whether users can rebuild the operating system of a WorkSpace to its original state.

        • SamlProperties (dict) --

          Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

          • Status (string) --

            Indicates the status of SAML 2.0 authentication. These statuses include the following.

            • If the setting is DISABLED , end users will be directed to login with their directory credentials.

            • If the setting is ENABLED , end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.

            • If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK , end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.

          • UserAccessUrl (string) --

            The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

          • RelayStateParameterName (string) --

            The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.

            To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.

        • CertificateBasedAuthProperties (dict) --

          The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

          • Status (string) --

            The status of the certificate-based authentication properties.

          • CertificateAuthorityArn (string) --

            The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.

        • WorkspaceDirectoryName (string) --

          The name fo the WorkSpace directory.

        • WorkspaceDirectoryDescription (string) --

          The description of the WorkSpace directory

        • UserIdentityType (string) --

          Indicates the identity type of the specifired user.

        • WorkspaceType (string) --

          Indicates whether the directory's WorkSpace type is personal or pools.

        • ActiveDirectoryConfig (dict) --

          Information about the Active Directory config.

          • DomainName (string) --

            The name of the domain.

          • ServiceAccountSecretArn (string) --

            Indicates the secret ARN on the service account.

        • StreamingProperties (dict) --

          The streaming properties to configure.

          • StreamingExperiencePreferredProtocol (string) --

            Indicates the type of preferred protocol for the streaming experience.

          • UserSettings (list) --

            Indicates the permission settings asscoiated with the user.

            • (dict) --

              Information about the user's permission settings.

              • Action (string) --

                Indicates the type of action.

              • Permission (string) --

                Indicates if the setting is enabled or disabled.

              • MaximumLength (integer) --

                Indicates the maximum character length for the specified user setting.

          • StorageConnectors (list) --

            Indicates the storage connector used

            • (dict) --

              Describes the storage connector.

              • ConnectorType (string) --

                The type of connector used to save user files.

              • Status (string) --

                Indicates if the storage connetor is enabled or disabled.

        • ErrorMessage (string) --

          The error message returned.

    • NextToken (string) --

      The token to use to retrieve the next page of results. This value is null when there are no more results to return.

ModifyWorkspaceCreationProperties (updated) Link ¶
Changes (request)
{'WorkspaceCreationProperties': {'InstanceIamRoleArn': 'string'}}

Modify the default properties used to create WorkSpaces.

See also: AWS API Documentation

Request Syntax

client.modify_workspace_creation_properties(
    ResourceId='string',
    WorkspaceCreationProperties={
        'EnableWorkDocs': True|False,
        'EnableInternetAccess': True|False,
        'DefaultOu': 'string',
        'CustomSecurityGroupId': 'string',
        'UserEnabledAsLocalAdministrator': True|False,
        'EnableMaintenanceMode': True|False,
        'InstanceIamRoleArn': 'string'
    }
)
type ResourceId

string

param ResourceId

[REQUIRED]

The identifier of the directory.

type WorkspaceCreationProperties

dict

param WorkspaceCreationProperties

[REQUIRED]

The default properties for creating WorkSpaces.

  • EnableWorkDocs (boolean) --

    Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

    Note

    If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide . To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide .

    If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

  • EnableInternetAccess (boolean) --

    Indicates whether internet access is enabled for your WorkSpaces.

  • DefaultOu (string) --

    The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value" , where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com .

    Warning

    • To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

    • The API doesn't validate whether the OU exists.

  • CustomSecurityGroupId (string) --

    The identifier of your custom security group.

  • UserEnabledAsLocalAdministrator (boolean) --

    Indicates whether users are local administrators of their WorkSpaces.

  • EnableMaintenanceMode (boolean) --

    Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

  • InstanceIamRoleArn (string) --

    Indicates the IAM role ARN of the instance.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

RegisterWorkspaceDirectory (updated) Link ¶
Changes (request, response)
Request
{'ActiveDirectoryConfig': {'DomainName': 'string',
                           'ServiceAccountSecretArn': 'string'},
 'UserIdentityType': 'CUSTOMER_MANAGED | AWS_DIRECTORY_SERVICE',
 'WorkspaceDirectoryDescription': 'string',
 'WorkspaceDirectoryName': 'string',
 'WorkspaceType': 'PERSONAL | POOLS'}
Response
{'DirectoryId': 'string',
 'State': 'REGISTERING | REGISTERED | DEREGISTERING | DEREGISTERED | ERROR'}

Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.

See also: AWS API Documentation

Request Syntax

client.register_workspace_directory(
    DirectoryId='string',
    SubnetIds=[
        'string',
    ],
    EnableWorkDocs=True|False,
    EnableSelfService=True|False,
    Tenancy='DEDICATED'|'SHARED',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    WorkspaceDirectoryName='string',
    WorkspaceDirectoryDescription='string',
    UserIdentityType='CUSTOMER_MANAGED'|'AWS_DIRECTORY_SERVICE',
    WorkspaceType='PERSONAL'|'POOLS',
    ActiveDirectoryConfig={
        'DomainName': 'string',
        'ServiceAccountSecretArn': 'string'
    }
)
type DirectoryId

string

param DirectoryId

The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.

type SubnetIds

list

param SubnetIds

The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.

  • (string) --

type EnableWorkDocs

boolean

param EnableWorkDocs

Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

type EnableSelfService

boolean

param EnableSelfService

Indicates whether self-service capabilities are enabled or disabled.

type Tenancy

string

param Tenancy

Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.

type Tags

list

param Tags

The tags associated with the directory.

  • (dict) --

    Describes a tag.

    • Key (string) -- [REQUIRED]

      The key of the tag.

    • Value (string) --

      The value of the tag.

type WorkspaceDirectoryName

string

param WorkspaceDirectoryName

The name of the directory to register.

type WorkspaceDirectoryDescription

string

param WorkspaceDirectoryDescription

Description of the directory to register.

type UserIdentityType

string

param UserIdentityType

The type of identity management the user is using.

type WorkspaceType

string

param WorkspaceType

Indicates whether the directory's WorkSpace type is personal or pools.

type ActiveDirectoryConfig

dict

param ActiveDirectoryConfig

The active directory config of the directory.

  • DomainName (string) -- [REQUIRED]

    The name of the domain.

  • ServiceAccountSecretArn (string) -- [REQUIRED]

    Indicates the secret ARN on the service account.

rtype

dict

returns

Response Syntax

{
    'DirectoryId': 'string',
    'State': 'REGISTERING'|'REGISTERED'|'DEREGISTERING'|'DEREGISTERED'|'ERROR'
}

Response Structure

  • (dict) --

    • DirectoryId (string) --

      The identifier of the directory.

    • State (string) --

      The registration status of the WorkSpace directory.