WorkSpaces / Client / modify_workspace_properties

modify_workspace_properties#

WorkSpaces.Client.modify_workspace_properties(**kwargs)#

Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

Note

The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

See also: AWS API Documentation

Request Syntax

response = client.modify_workspace_properties(
    WorkspaceId='string',
    WorkspaceProperties={
        'RunningMode': 'AUTO_STOP'|'ALWAYS_ON'|'MANUAL',
        'RunningModeAutoStopTimeoutInMinutes': 123,
        'RootVolumeSizeGib': 123,
        'UserVolumeSizeGib': 123,
        'ComputeTypeName': 'VALUE'|'STANDARD'|'PERFORMANCE'|'POWER'|'GRAPHICS'|'POWERPRO'|'GRAPHICSPRO'|'GRAPHICS_G4DN'|'GRAPHICSPRO_G4DN',
        'Protocols': [
            'PCOIP'|'WSP',
        ],
        'OperatingSystemName': 'AMAZON_LINUX_2'|'UBUNTU_18_04'|'UBUNTU_20_04'|'UBUNTU_22_04'|'UNKNOWN'|'WINDOWS_10'|'WINDOWS_11'|'WINDOWS_7'|'WINDOWS_SERVER_2016'|'WINDOWS_SERVER_2019'|'WINDOWS_SERVER_2022'
    },
    DataReplication='NO_REPLICATION'|'PRIMARY_AS_SOURCE'
)
Parameters:

  • WorkspaceId (string) –

    [REQUIRED]

    The identifier of the WorkSpace.

  • WorkspaceProperties (dict) –

    The properties of the WorkSpace.

    • RunningMode (string) –

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

      Note

      The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

    • 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. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

    • UserVolumeSizeGib (integer) –

      The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

    • ComputeTypeName (string) –

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

    • Protocols (list) –

      The protocol. For more information, see Protocols for Amazon WorkSpaces.

      Note

      • Only available for WorkSpaces created with PCoIP bundles.

      • The Protocols property is case sensitive. Ensure you use PCOIP or WSP.

      • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

      • (string) –

    • OperatingSystemName (string) –

      The name of the operating system.

  • DataReplication (string) – Indicates the data replication status.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • WorkSpaces.Client.exceptions.InvalidParameterValuesException

  • WorkSpaces.Client.exceptions.InvalidResourceStateException

  • WorkSpaces.Client.exceptions.OperationInProgressException

  • WorkSpaces.Client.exceptions.UnsupportedWorkspaceConfigurationException

  • WorkSpaces.Client.exceptions.ResourceNotFoundException

  • WorkSpaces.Client.exceptions.AccessDeniedException

  • WorkSpaces.Client.exceptions.ResourceUnavailableException