Query the details of a PAI workspace - Resource Orchestration Service

DATASOURCE::PAI::Workspace is used to query the information about a Platform for AI (PAI) workspace.

Syntax

{
  "Type": "DATASOURCE::PAI::Workspace",
  "Properties": {
    "WorkspaceId": String,
    "RefreshOptions": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

WorkspaceId

String

Yes

The ID of the PAI workspace.

None.

RefreshOptions

String

Yes

The refresh policy for data source resources when the stack is updated.

Valid values:

Never (default): does not refresh data source resources when the stack is updated.
Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

IsDefault: indicates whether the workspace is the default workspace.
Description: the description of the workspace.
AdminNames: the names of the administrator accounts.
DisplayName: the display name.
WorkspaceId: the ID of the workspace.
WorkspaceName: the name of the workspace.
ExtraInfos: the additional information, including TenantId (tenant ID).
Creator: the ID of the user who creates the workspace.
Users: the information about the workspace owner.
EnvTypes: the environment information of the workspace.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  WorkspaceId:
    Type: String
    Description:
      en: The ID of the workspace.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::PAI::Workspace
    Properties:
      WorkspaceId:
        Ref: WorkspaceId
Outputs:
  IsDefault:
    Description: Default Workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - IsDefault
  Description:
    Description: The description of the workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  AdminNames:
    Description: List of administrator account names.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - AdminNames
  DisplayName:
    Description: The display name of the workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - DisplayName
  WorkspaceId:
    Description: The first ID of the resource.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - WorkspaceId
  WorkspaceName:
    Description: The name of the workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - WorkspaceName
  ExtraInfos:
    Description: Additional information, currently including TenantId (tenant ID).
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ExtraInfos
  Creator:
    Description: The user ID of the creator.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Creator
  Users:
    Description: List of users.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Users
  EnvTypes:
    Description: The environments of the workspace.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - EnvTypes

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "WorkspaceId": {
      "Type": "String",
      "Description": {
        "en": "The ID of the workspace."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::PAI::Workspace",
      "Properties": {
        "WorkspaceId": {
          "Ref": "WorkspaceId"
        }
      }
    }
  },
  "Outputs": {
    "IsDefault": {
      "Description": "Default Workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "IsDefault"
        ]
      }
    },
    "Description": {
      "Description": "The description of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "AdminNames": {
      "Description": "List of administrator account names.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "AdminNames"
        ]
      }
    },
    "DisplayName": {
      "Description": "The display name of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "DisplayName"
        ]
      }
    },
    "WorkspaceId": {
      "Description": "The first ID of the resource.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "WorkspaceId"
        ]
      }
    },
    "WorkspaceName": {
      "Description": "The name of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "WorkspaceName"
        ]
      }
    },
    "ExtraInfos": {
      "Description": "Additional information, currently including TenantId (tenant ID).",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ExtraInfos"
        ]
      }
    },
    "Creator": {
      "Description": "The user ID of the creator.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Creator"
        ]
      }
    },
    "Users": {
      "Description": "List of users.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Users"
        ]
      }
    },
    "EnvTypes": {
      "Description": "The environments of the workspace.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "EnvTypes"
        ]
      }
    }
  }
}