DescribeWorkspacesRequest schema from Amazon WorkSpaces API
Type: objectProperties: 6
DesktopEnd User ComputingVirtual DesktopDesktop as a Service
DescribeWorkspacesRequest is a JSON Structure definition published by Amazon WorkSpaces, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"type": "object",
"name": "DescribeWorkspacesRequest",
"properties": {
"WorkspaceIds": {
"allOf": [
{
"$ref": "#/components/schemas/WorkspaceIdList"
},
{
"description": "<p>The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.</p> <p>Because the <a>CreateWorkspaces</a> operation is asynchronous, the identifier it returns is not immediately available. If you immediately call <a>DescribeWorkspaces</a> with this identifier, no information is returned.</p>"
}
]
},
"DirectoryId": {
"allOf": [
{
"$ref": "#/components/schemas/DirectoryId"
},
{
"description": "The identifier of the directory. In addition, you can optionally specify a specific directory user (see <code>UserName</code>). You cannot combine this parameter with any other filter."
}
]
},
"UserName": {
"allOf": [
{
"$ref": "#/components/schemas/UserName"
},
{
"description": "The name of the directory user. You must specify this parameter with <code>DirectoryId</code>."
}
]
},
"BundleId": {
"allOf": [
{
"$ref": "#/components/schemas/BundleId"
},
{
"description": "The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter."
}
]
},
"Limit": {
"allOf": [
{
"$ref": "#/components/schemas/Limit"
},
{
"description": "The maximum number of items to return."
}
]
},
"NextToken": {
"allOf": [
{
"$ref": "#/components/schemas/PaginationToken"
},
{
"description": "If you received a <code>NextToken</code> from a previous call that was paginated, provide this token to receive the next set of results."
}
]
}
},
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-structure/workspaces-describe-workspaces-request-structure.json",
"description": "DescribeWorkspacesRequest schema from Amazon WorkSpaces API"
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.