Amazon WorkSpaces · JSON Structure

Workspaces Pending Create Standby Workspaces Request Structure

Information about the standby WorkSpace.

Type: object Properties: 4
DesktopEnd User ComputingVirtual DesktopDesktop as a Service

PendingCreateStandbyWorkspacesRequest is a JSON Structure definition published by Amazon WorkSpaces, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserName DirectoryId State WorkspaceId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "UserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserName"
        },
        {
          "description": "<p>Describes the standby WorkSpace that was created.</p> <p>Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html\"> DescribeWorkspaces</a> before the WorkSpace is created, the information returned can be incomplete. </p>"
        }
      ]
    },
    "DirectoryId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DirectoryId"
        },
        {
          "description": "The identifier of the directory for the standby WorkSpace."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceState"
        },
        {
          "description": "The operational state of the standby WorkSpace."
        }
      ]
    },
    "WorkspaceId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WorkspaceId"
        },
        {
          "description": "The identifier of the standby WorkSpace."
        }
      ]
    }
  },
  "description": "Information about the standby WorkSpace.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "name": "PendingCreateStandbyWorkspacesRequest",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-structure/workspaces-pending-create-standby-workspaces-request-structure.json"
}