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.

Describes the specified WorkSpaces Pools.

Usage¶

workspaces_describe_workspaces_pools(PoolIds, Filters, Limit, NextToken)

Arguments¶

PoolIds

The identifier of the WorkSpaces Pools.
Filters

The filter conditions for the WorkSpaces Pool to return.
Limit

The maximum number of items to return.
NextToken

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

Value¶

A list with the following syntax:

list(
  WorkspacesPools = list(
    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"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_workspaces_pools(
  PoolIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "PoolName",
      Values = list(
        "string"
      ),
      Operator = "EQUALS"|"NOTEQUALS"|"CONTAINS"|"NOTCONTAINS"
    )
  ),
  Limit = 123,
  NextToken = "string"
)