End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools¶

Description¶

End of support notice: On December 31, 2027, Amazon Web Services will end support for Amazon WorkSpaces Pools. After December 31, 2027, you will no longer be able to access the Amazon WorkSpaces Pools console or Amazon WorkSpaces Pools resources. For more information, see Amazon WorkSpaces Pools end of support.

Updates the specified pool.

Usage¶

workspaces_update_workspaces_pool(PoolId, Description, BundleId,
  DirectoryId, Capacity, ApplicationSettings, TimeoutSettings,
  RunningMode)

Arguments¶

PoolId

[required] The identifier of the specified pool to update.
Description

Describes the specified pool to update.
BundleId

The identifier of the bundle.
DirectoryId

The identifier of the directory.
Capacity

The desired capacity for the pool.
ApplicationSettings

The persistent application settings for users in the pool.
TimeoutSettings

Indicates the timeout settings of the specified pool.
RunningMode

The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped state.

Value¶

A list with the following syntax:

list(
  WorkspacesPool = list(
    PoolId = "string",
    PoolArn = "string",
    CapacityStatus = list(
      AvailableUserSessions = 123,
      DesiredUserSessions = 123,
      ActualUserSessions = 123,
      ActiveUserSessions = 123
    ),
    PoolName = "string",
    Description = "string",
    State = "CREATING"|"DELETING"|"RUNNING"|"STARTING"|"STOPPED"|"STOPPING"|"UPDATING",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    BundleId = "string",
    DirectoryId = "string",
    Errors = list(
      list(
        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 = list(
      Status = "DISABLED"|"ENABLED",
      SettingsGroup = "string",
      S3BucketName = "string"
    ),
    TimeoutSettings = list(
      DisconnectTimeoutInSeconds = 123,
      IdleDisconnectTimeoutInSeconds = 123,
      MaxUserDurationInSeconds = 123
    ),
    RunningMode = "AUTO_STOP"|"ALWAYS_ON"
  )
)

Request syntax¶

svc$update_workspaces_pool(
  PoolId = "string",
  Description = "string",
  BundleId = "string",
  DirectoryId = "string",
  Capacity = list(
    DesiredUserSessions = 123
  ),
  ApplicationSettings = list(
    Status = "DISABLED"|"ENABLED",
    SettingsGroup = "string"
  ),
  TimeoutSettings = list(
    DisconnectTimeoutInSeconds = 123,
    IdleDisconnectTimeoutInSeconds = 123,
    MaxUserDurationInSeconds = 123
  ),
  RunningMode = "AUTO_STOP"|"ALWAYS_ON"
)