openapi: 3.2.0
info:
version: '2015-04-08'
x-release: v4
title: Amazon WorkSpaces API
description: 'Amazon WorkSpaces Service
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces.'
x-logo:
url: https://twitter.com/awscloud/profile_image?size=original
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: workspaces
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/workspaces-2015-04-08.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://workspaces.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon WorkSpaces multi-region endpoint
- url: https://workspaces.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Amazon WorkSpaces multi-region endpoint
- url: http://workspaces.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon WorkSpaces endpoint for China (Beijing) and China (Ningxia)
- url: https://workspaces.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Amazon WorkSpaces endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Amazon WorkSpaces
paths:
/#X-Amz-Target=WorkspacesService.AssociateConnectionAlias:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AssociateConnectionAlias
description: 'Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateConnectionAliasResult'
'480':
description: ResourceAssociatedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAssociatedException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'484':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'485':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateConnectionAliasRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.AssociateConnectionAlias
summary: Amazon WorkSpaces Associate Connection Alias
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.AssociateIpGroups:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AssociateIpGroups
description: Associates the specified IP access control group with the specified directory.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateIpGroupsResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'483':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateIpGroupsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.AssociateIpGroups
summary: Amazon WorkSpaces Associate Ip Groups
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.AuthorizeIpRules:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AuthorizeIpRules
description: 'Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizeIpRulesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'483':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AuthorizeIpRulesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.AuthorizeIpRules
summary: Amazon WorkSpaces Authorize Ip Rules
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CopyWorkspaceImage:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CopyWorkspaceImage
description: 'Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CopyWorkspaceImageResult'
'480':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'481':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'484':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CopyWorkspaceImageRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CopyWorkspaceImage
summary: Amazon WorkSpaces Copy Workspace Image
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateConnectClientAddIn:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateConnectClientAddIn
description: 'Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConnectClientAddInResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourceCreationFailedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceCreationFailedException'
'483':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConnectClientAddInRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateConnectClientAddIn
summary: Amazon WorkSpaces Create Connect Client Add in
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateConnectionAlias:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateConnectionAlias
description: Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConnectionAliasResult'
'480':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'483':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'484':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'485':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateConnectionAliasRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateConnectionAlias
summary: Amazon WorkSpaces Create Connection Alias
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateIpGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateIpGroup
description: 'Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don''t associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIpGroupResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'482':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'483':
description: ResourceCreationFailedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceCreationFailedException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateIpGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateIpGroup
summary: Amazon WorkSpaces Create Ip Group
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateStandbyWorkspaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateStandbyWorkspaces
description: Creates a standby WorkSpace in a secondary Region.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateStandbyWorkspacesResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateStandbyWorkspacesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateStandbyWorkspaces
summary: Amazon WorkSpaces Create Standby Workspaces
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateTags:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateTags
description: Creates the specified tags for the specified WorkSpaces resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTagsResult'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTagsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateTags
summary: Amazon WorkSpaces Create Tags
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateUpdatedWorkspaceImage:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateUpdatedWorkspaceImage
description: 'Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.
Microsoft Windows updates and other application updates are not included in the update process.
The source WorkSpace image is not deleted. You can delete the source image after you''ve verified your new updated image and created a new bundle.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdatedWorkspaceImageResult'
'480':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'481':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'484':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUpdatedWorkspaceImageRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateUpdatedWorkspaceImage
summary: Amazon WorkSpaces Create Updated Workspace Image
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateWorkspaceBundle:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateWorkspaceBundle
description: Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkspaceBundleResult'
'480':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'481':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'482':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'483':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkspaceBundleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateWorkspaceBundle
summary: Amazon WorkSpaces Create Workspace Bundle
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateWorkspaceImage:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateWorkspaceImage
description: Creates a new WorkSpace image from an existing WorkSpace.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkspaceImageResult'
'480':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'481':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'484':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkspaceImageRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateWorkspaceImage
summary: Amazon WorkSpaces Create Workspace Image
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.CreateWorkspaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateWorkspaces
description: 'Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkspacesResult'
'480':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWorkspacesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.CreateWorkspaces
summary: Amazon WorkSpaces Create Workspaces
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DeleteClientBranding:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteClientBranding
description: 'Deletes customized client branding. Client branding allows you to customize your WorkSpace''s client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you delete your customized client branding, your login portal reverts to the default client branding.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteClientBrandingResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteClientBrandingRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DeleteClientBranding
summary: Amazon WorkSpaces Delete Client Branding
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DeleteConnectClientAddIn:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteConnectClientAddIn
description: Deletes a client-add-in for Amazon Connect that is configured within a directory.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConnectClientAddInResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConnectClientAddInRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DeleteConnectClientAddIn
summary: Amazon WorkSpaces Delete Connect Client Add in
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DeleteConnectionAlias:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteConnectionAlias
description: 'Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConnectionAliasResult'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ResourceAssociatedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAssociatedException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'484':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'485':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConnectionAliasRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DeleteConnectionAlias
summary: Amazon WorkSpaces Delete Connection Alias
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DeleteIpGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteIpGroup
description: 'Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteIpGroupResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourceAssociatedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAssociatedException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteIpGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DeleteIpGroup
summary: Amazon WorkSpaces Delete Ip Group
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DeleteTags:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteTags
description: Deletes the specified tags from the specified WorkSpaces resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTagsResult'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteTagsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DeleteTags
summary: Amazon WorkSpaces Delete Tags
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DeleteWorkspaceBundle:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteWorkspaceBundle
description: Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWorkspaceBundleResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourceAssociatedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAssociatedException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWorkspaceBundleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DeleteWorkspaceBundle
summary: Amazon WorkSpaces Delete Workspace Bundle
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DeleteWorkspaceImage:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteWorkspaceImage
description: Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWorkspaceImageResult'
'480':
description: ResourceAssociatedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAssociatedException'
'481':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteWorkspaceImageRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DeleteWorkspaceImage
summary: Amazon WorkSpaces Delete Workspace Image
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DeregisterWorkspaceDirectory:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeregisterWorkspaceDirectory
description: 'Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeregisterWorkspaceDirectoryResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeregisterWorkspaceDirectoryRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DeregisterWorkspaceDirectory
summary: Amazon WorkSpaces Deregister Workspace Directory
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeAccount:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeAccount
description: Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeAccountResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeAccountRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeAccount
summary: Amazon WorkSpaces Describe Account
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeAccountModifications:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeAccountModifications
description: Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeAccountModificationsResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeAccountModificationsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeAccountModifications
summary: Amazon WorkSpaces Describe Account Modifications
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeClientBranding:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeClientBranding
description: 'Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
Only device types that have branding information configured will be shown in the response.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeClientBrandingResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeClientBrandingRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeClientBranding
summary: Amazon WorkSpaces Describe Client Branding
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeClientProperties:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeClientProperties
description: Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeClientPropertiesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeClientPropertiesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeClientProperties
summary: Amazon WorkSpaces Describe Client Properties
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeConnectClientAddIns:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeConnectClientAddIns
description: Retrieves a list of Amazon Connect client add-ins that have been created.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeConnectClientAddInsResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeConnectClientAddInsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeConnectClientAddIns
summary: Amazon WorkSpaces Describe Connect Client Add Ins
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeConnectionAliasPermissions:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeConnectionAliasPermissions
description: Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeConnectionAliasPermissionsResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeConnectionAliasPermissionsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeConnectionAliasPermissions
summary: Amazon WorkSpaces Describe Connection Alias Permissions
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeConnectionAliases:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeConnectionAliases
description: Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeConnectionAliasesResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeConnectionAliasesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeConnectionAliases
summary: Amazon WorkSpaces Describe Connection Aliases
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeIpGroups:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeIpGroups
description: Describes one or more of your IP access control groups.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeIpGroupsResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeIpGroupsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeIpGroups
summary: Amazon WorkSpaces Describe Ip Groups
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeTags:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeTags
description: Describes the specified tags for the specified WorkSpaces resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeTagsResult'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeTagsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeTags
summary: Amazon WorkSpaces Describe Tags
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeWorkspaceBundles:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeWorkspaceBundles
description: 'Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceBundlesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceBundlesRequest'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeWorkspaceBundles
summary: Amazon WorkSpaces Describe Workspace Bundles
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectories:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeWorkspaceDirectories
description: Describes the available directories that are registered with Amazon WorkSpaces.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceDirectoriesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceDirectoriesRequest'
parameters:
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeWorkspaceDirectories
summary: Amazon WorkSpaces Describe Workspace Directories
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeWorkspaceImagePermissions:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeWorkspaceImagePermissions
description: Describes the permissions that the owner of an image has granted to other Amazon Web Services accounts for an image.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceImagePermissionsResult'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceImagePermissionsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeWorkspaceImagePermissions
summary: Amazon WorkSpaces Describe Workspace Image Permissions
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeWorkspaceImages:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeWorkspaceImages
description: Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceImagesResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceImagesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeWorkspaceImages
summary: Amazon WorkSpaces Describe Workspace Images
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeWorkspaceSnapshots:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeWorkspaceSnapshots
description: Describes the snapshots for the specified WorkSpace.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceSnapshotsResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspaceSnapshotsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeWorkspaceSnapshots
summary: Amazon WorkSpaces Describe Workspace Snapshots
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeWorkspaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeWorkspaces
description: 'Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspacesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspacesRequest'
parameters:
- name: Limit
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeWorkspaces
summary: Amazon WorkSpaces Describe Workspaces
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DescribeWorkspacesConnectionStatus:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DescribeWorkspacesConnectionStatus
description: Describes the connection status of the specified WorkSpaces.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspacesConnectionStatusResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeWorkspacesConnectionStatusRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DescribeWorkspacesConnectionStatus
summary: Amazon WorkSpaces Describe Workspaces Connection Status
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DisassociateConnectionAlias:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DisassociateConnectionAlias
description: 'Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateConnectionAliasResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'483':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'484':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateConnectionAliasRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DisassociateConnectionAlias
summary: Amazon WorkSpaces Disassociate Connection Alias
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.DisassociateIpGroups:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DisassociateIpGroups
description: Disassociates the specified IP access control group from the specified directory.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateIpGroupsResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateIpGroupsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.DisassociateIpGroups
summary: Amazon WorkSpaces Disassociate Ip Groups
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ImportClientBranding:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ImportClientBranding
description: 'Imports client branding. Client branding allows you to customize your WorkSpace''s client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
You must specify at least one platform type when importing client branding.
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.
Imported data can take up to a minute to appear in the WorkSpaces client.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ImportClientBrandingResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImportClientBrandingRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ImportClientBranding
summary: Amazon WorkSpaces Import Client Branding
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ImportWorkspaceImage:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ImportWorkspaceImage
description: Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ImportWorkspaceImageResult'
'480':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'481':
description: ResourceAlreadyExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAlreadyExistsException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImportWorkspaceImageRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ImportWorkspaceImage
summary: Amazon WorkSpaces Import Workspace Image
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ListAvailableManagementCidrRanges:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListAvailableManagementCidrRanges
description: 'Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by Amazon Web Services accounts that are enabled for BYOL. If your account isn''t enabled for BYOL, you''ll receive an AccessDeniedException error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListAvailableManagementCidrRangesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListAvailableManagementCidrRangesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ListAvailableManagementCidrRanges
summary: Amazon WorkSpaces List Available Management Cidr Ranges
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.MigrateWorkspace:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: MigrateWorkspace
description: 'Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root volume from the target bundle image and the user volume from the last available snapshot of the original WorkSpace. During migration, the original D:\Users\%USERNAME% user profile folder is renamed to D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated. A new D:\Users\%USERNAME%\ folder is generated by the new OS. Certain files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/MigrateWorkspaceResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'484':
description: OperationInProgressException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationInProgressException'
'485':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/MigrateWorkspaceRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.MigrateWorkspace
summary: Amazon WorkSpaces Migrate Workspace
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifyAccount:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifyAccount
description: Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyAccountResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'483':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyAccountRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifyAccount
summary: Amazon WorkSpaces Modify Account
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifyCertificateBasedAuthProperties:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifyCertificateBasedAuthProperties
description: Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyCertificateBasedAuthPropertiesResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyCertificateBasedAuthPropertiesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifyCertificateBasedAuthProperties
summary: Amazon WorkSpaces Modify Certificate Based Auth Properties
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifyClientProperties:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifyClientProperties
description: Modifies the properties of the specified Amazon WorkSpaces clients.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyClientPropertiesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyClientPropertiesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifyClientProperties
summary: Amazon WorkSpaces Modify Client Properties
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifySamlProperties:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifySamlProperties
description: Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifySamlPropertiesResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifySamlPropertiesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifySamlProperties
summary: Amazon WorkSpaces Modify Saml Properties
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifySelfservicePermissions:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifySelfservicePermissions
description: Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifySelfservicePermissionsResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifySelfservicePermissionsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifySelfservicePermissions
summary: Amazon WorkSpaces Modify Selfservice Permissions
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifyWorkspaceAccessProperties:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifyWorkspaceAccessProperties
description: Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyWorkspaceAccessPropertiesResult'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyWorkspaceAccessPropertiesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifyWorkspaceAccessProperties
summary: Amazon WorkSpaces Modify Workspace Access Properties
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifyWorkspaceCreationProperties:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifyWorkspaceCreationProperties
description: Modify the default properties used to create WorkSpaces.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyWorkspaceCreationPropertiesResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyWorkspaceCreationPropertiesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifyWorkspaceCreationProperties
summary: Amazon WorkSpaces Modify Workspace Creation Properties
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifyWorkspaceProperties:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifyWorkspaceProperties
description: 'Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
The MANUAL running mode value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyWorkspacePropertiesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'482':
description: OperationInProgressException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationInProgressException'
'483':
description: UnsupportedWorkspaceConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedWorkspaceConfigurationException'
'484':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyWorkspacePropertiesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifyWorkspaceProperties
summary: Amazon WorkSpaces Modify Workspace Properties
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.ModifyWorkspaceState:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ModifyWorkspaceState
description: 'Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyWorkspaceStateResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyWorkspaceStateRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.ModifyWorkspaceState
summary: Amazon WorkSpaces Modify Workspace State
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.RebootWorkspaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: RebootWorkspaces
description: 'Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY.
This operation is asynchronous and returns before the WorkSpaces have rebooted.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RebootWorkspacesResult'
'480':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RebootWorkspacesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.RebootWorkspaces
summary: Amazon WorkSpaces Reboot Workspaces
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.RebuildWorkspaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: RebuildWorkspaces
description: 'Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, STOPPED, or REBOOTING.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RebuildWorkspacesResult'
'480':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RebuildWorkspacesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.RebuildWorkspaces
summary: Amazon WorkSpaces Rebuild Workspaces
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.RegisterWorkspaceDirectory:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: RegisterWorkspaceDirectory
description: Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterWorkspaceDirectoryResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: WorkspacesDefaultRoleNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspacesDefaultRoleNotFoundException'
'485':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'486':
description: UnsupportedNetworkConfigurationException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedNetworkConfigurationException'
'487':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterWorkspaceDirectoryRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.RegisterWorkspaceDirectory
summary: Amazon WorkSpaces Register Workspace Directory
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.RestoreWorkspace:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: RestoreWorkspace
description: 'Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, UNHEALTHY, or STOPPED.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreWorkspaceResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RestoreWorkspaceRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.RestoreWorkspace
summary: Amazon WorkSpaces Restore Workspace
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.RevokeIpRules:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: RevokeIpRules
description: Removes one or more rules from the specified IP access control group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RevokeIpRulesResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RevokeIpRulesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.RevokeIpRules
summary: Amazon WorkSpaces Revoke Ip Rules
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.StartWorkspaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: StartWorkspaces
description: 'Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StartWorkspacesResult'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StartWorkspacesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.StartWorkspaces
summary: Amazon WorkSpaces Start Workspaces
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.StopWorkspaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: StopWorkspaces
description: 'Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/StopWorkspacesResult'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StopWorkspacesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.StopWorkspaces
summary: Amazon WorkSpaces Stop Workspaces
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.TerminateWorkspaces:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: TerminateWorkspaces
description: 'Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user''s data is destroyed. If you need to archive any user data, contact Amazon Web Services Support before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED.
This operation is asynchronous and returns before the WorkSpaces have been completely terminated. After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn''t returned, then the WorkSpace has been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TerminateWorkspacesResult'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TerminateWorkspacesRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.TerminateWorkspaces
summary: Amazon WorkSpaces Terminate Workspaces
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.UpdateConnectClientAddIn:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateConnectClientAddIn
description: Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateConnectClientAddInResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateConnectClientAddInRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.UpdateConnectClientAddIn
summary: Amazon WorkSpaces Update Connect Client Add in
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.UpdateConnectionAliasPermission:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateConnectionAliasPermission
description: 'Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.
To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateConnectionAliasPermissionResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ResourceAssociatedException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceAssociatedException'
'485':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'486':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateConnectionAliasPermissionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.UpdateConnectionAliasPermission
summary: Amazon WorkSpaces Update Connection Alias Permission
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.UpdateRulesOfIpGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateRulesOfIpGroup
description: Replaces the current rules of the specified IP access control group with the specified rules.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRulesOfIpGroupResult'
'480':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourceLimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceLimitExceededException'
'483':
description: InvalidResourceStateException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidResourceStateException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRulesOfIpGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.UpdateRulesOfIpGroup
summary: Amazon WorkSpaces Update Rules of Ip Group
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.UpdateWorkspaceBundle:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateWorkspaceBundle
description: 'Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren''t automatically updated when you update the bundle that they''re based on. To update existing WorkSpaces that are based on a bundle that you''ve updated, you must either rebuild the WorkSpaces or delete and recreate them.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkspaceBundleResult'
'480':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'481':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'484':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkspaceBundleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.UpdateWorkspaceBundle
summary: Amazon WorkSpaces Update Workspace Bundle
tags:
- Amazon WorkSpaces
/#X-Amz-Target=WorkspacesService.UpdateWorkspaceImagePermission:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateWorkspaceImagePermission
description: 'Shares or unshares an image with one account in the same Amazon Web Services Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
To delete an image that has been shared, you must unshare the image before you delete it.
Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn''t supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkspaceImagePermissionResult'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InvalidParameterValuesException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValuesException'
'484':
description: OperationNotSupportedException
content:
application/json:
schema:
$ref: '#/components/schemas/OperationNotSupportedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkspaceImagePermissionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- WorkspacesService.UpdateWorkspaceImagePermission
summary: Amazon WorkSpaces Update Workspace Image Permission
tags:
- Amazon WorkSpaces
components:
schemas:
DeleteIpGroupRequest:
type: object
required:
- GroupId
title: DeleteIpGroupRequest
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/IpGroupId'
- description: The identifier of the IP access control group.
PendingCreateStandbyWorkspacesRequestList:
type: array
items:
$ref: '#/components/schemas/PendingCreateStandbyWorkspacesRequest'
UpdateConnectionAliasPermissionRequest:
type: object
required:
- AliasId
- ConnectionAliasPermission
title: UpdateConnectionAliasPermissionRequest
properties:
AliasId:
allOf:
- $ref: '#/components/schemas/ConnectionAliasId'
- description: The identifier of the connection alias that you want to update permissions for.
ConnectionAliasPermission:
allOf:
- $ref: '#/components/schemas/ConnectionAliasPermission'
- description: Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.
ResourceUnavailableException: {}
DescribeAccountRequest:
type: object
title: DescribeAccountRequest
properties: {}
ListAvailableManagementCidrRangesResult:
type: object
properties:
ManagementCidrRanges:
allOf:
- $ref: '#/components/schemas/DedicatedTenancyCidrRangeList'
- description: The list of available IP address ranges, specified as IPv4 CIDR blocks.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
Timestamp:
type: string
format: date-time
DirectoryId:
type: string
pattern: ^d-[0-9a-f]{8,63}$
minLength: 10
maxLength: 65
WorkspaceImageName:
type: string
pattern: ^[a-zA-Z0-9_./()\\-]+$
minLength: 1
maxLength: 64
RegisterWorkspaceDirectoryResult:
type: object
properties: {}
DescribeConnectClientAddInsResult:
type: object
properties:
AddIns:
allOf:
- $ref: '#/components/schemas/ConnectClientAddInList'
- description: Information about client add-ins.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
DeletableCertificateBasedAuthPropertiesList:
type: array
items:
$ref: '#/components/schemas/DeletableCertificateBasedAuthProperty'
IpRuleItem:
type: object
properties:
ipRule:
allOf:
- $ref: '#/components/schemas/IpRule'
- description: The IP address range, in CIDR notation.
ruleDesc:
allOf:
- $ref: '#/components/schemas/IpRuleDesc'
- description: The description.
description: Describes a rule for an IP access control group.
StandbyWorkspaceRelationshipType:
type: string
enum:
- PRIMARY
- STANDBY
IpRuleList:
type: array
items:
$ref: '#/components/schemas/IpRuleItem'
UpdateDescription:
type: string
pattern: ^[a-zA-Z0-9_./() -]+$
minLength: 1
maxLength: 255
RootStorage:
type: object
properties:
Capacity:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The size of the root volume.
description: Describes the root volume for a WorkSpace bundle.
CertificateBasedAuthProperties:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/CertificateBasedAuthStatusEnum'
- description: The status of the certificate-based authentication properties.
CertificateAuthorityArn:
allOf:
- $ref: '#/components/schemas/CertificateAuthorityArn'
- description: The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager Private CA resource.
description: Describes the properties of the certificate-based authentication you want to use with your WorkSpaces.
WorkspaceList:
type: array
items:
$ref: '#/components/schemas/Workspace'
ModifyWorkspaceCreationPropertiesRequest:
type: object
required:
- ResourceId
- WorkspaceCreationProperties
title: ModifyWorkspaceCreationPropertiesRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory.
WorkspaceCreationProperties:
allOf:
- $ref: '#/components/schemas/WorkspaceCreationProperties'
- description: The default properties for creating WorkSpaces.
SnapshotList:
type: array
items:
$ref: '#/components/schemas/Snapshot'
FailedStartWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
FailedCreateStandbyWorkspacesRequest:
type: object
properties:
StandbyWorkspaceRequest:
allOf:
- $ref: '#/components/schemas/StandbyWorkspace'
- description: Information about the standby WorkSpace that could not be created.
ErrorCode:
allOf:
- $ref: '#/components/schemas/WorkspaceErrorCode'
- description: The error code that is returned if the standby WorkSpace could not be created.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/Description'
- description: The text of the error message that is returned if the standby WorkSpace could not be created.
description: Describes the standby WorkSpace that could not be created.
WorkspaceRequestList:
type: array
items:
$ref: '#/components/schemas/WorkspaceRequest'
minItems: 1
maxItems: 25
DefaultOu:
type: string
IpAddress:
type: string
DescribeWorkspaceImagesRequest:
type: object
title: DescribeWorkspaceImagesRequest
properties:
ImageIds:
allOf:
- $ref: '#/components/schemas/WorkspaceImageIdList'
- description: The identifier of the image.
ImageType:
allOf:
- $ref: '#/components/schemas/ImageType'
- description: The type (owned or shared) of the image.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/Limit'
- description: The maximum number of items to return.
ConnectionAliasList:
type: array
items:
$ref: '#/components/schemas/ConnectionAlias'
minItems: 1
maxItems: 25
StartWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/StartRequest'
minItems: 1
maxItems: 25
IpRule:
type: string
CreateIpGroupRequest:
type: object
required:
- GroupName
title: CreateIpGroupRequest
properties:
GroupName:
allOf:
- $ref: '#/components/schemas/IpGroupName'
- description: The name of the group.
GroupDesc:
allOf:
- $ref: '#/components/schemas/IpGroupDesc'
- description: The description of the group.
UserRules:
allOf:
- $ref: '#/components/schemas/IpRuleList'
- description: The rules to add to the group.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags. Each WorkSpaces resource can have a maximum of 50 tags.
FailedStopWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
UserStorage:
type: object
properties:
Capacity:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The size of the user volume.
description: Describes the user volume for a WorkSpace bundle.
SubnetIds:
type: array
items:
$ref: '#/components/schemas/SubnetId'
maxItems: 2
RebuildWorkspacesRequest:
type: object
required:
- RebuildWorkspaceRequests
title: RebuildWorkspacesRequest
properties:
RebuildWorkspaceRequests:
allOf:
- $ref: '#/components/schemas/RebuildWorkspaceRequests'
- description: The WorkSpace to rebuild. You can specify a single WorkSpace.
DirectoryList:
type: array
items:
$ref: '#/components/schemas/WorkspaceDirectory'
RebootWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/RebootRequest'
minItems: 1
maxItems: 25
FailedWorkspaceChangeRequest:
type: object
properties:
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace.
ErrorCode:
allOf:
- $ref: '#/components/schemas/ErrorType'
- description: The error code that is returned if the WorkSpace cannot be rebooted.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/Description'
- description: The text of the error message that is returned if the WorkSpace cannot be rebooted.
description: Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).
AmazonUuid:
type: string
pattern: '[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}'
minLength: 36
maxLength: 36
UserVolumeSizeGib:
type: integer
DescribeConnectionAliasPermissionsResult:
type: object
properties:
AliasId:
allOf:
- $ref: '#/components/schemas/ConnectionAliasId'
- description: The identifier of the connection alias.
ConnectionAliasPermissions:
allOf:
- $ref: '#/components/schemas/ConnectionAliasPermissions'
- description: The permissions associated with a connection alias.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
DescribeWorkspaceDirectoriesResult:
type: object
properties:
Directories:
allOf:
- $ref: '#/components/schemas/DirectoryList'
- description: Information about the directories.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
OperationNotSupportedException: {}
AccessPropertyValue:
type: string
enum:
- ALLOW
- DENY
RestoreWorkspaceRequest:
type: object
required:
- WorkspaceId
title: RestoreWorkspaceRequest
properties:
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace.
DedicatedTenancyCidrRangeList:
type: array
items:
$ref: '#/components/schemas/DedicatedTenancyManagementCidrRange'
ImportWorkspaceImageResult:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the WorkSpace image.
DescribeClientPropertiesResult:
type: object
properties:
ClientPropertiesList:
allOf:
- $ref: '#/components/schemas/ClientPropertiesList'
- description: Information about the specified Amazon WorkSpaces clients.
RebootWorkspacesResult:
type: object
properties:
FailedRequests:
allOf:
- $ref: '#/components/schemas/FailedRebootWorkspaceRequests'
- description: Information about the WorkSpaces that could not be rebooted.
DeleteConnectionAliasResult:
type: object
properties: {}
DescribeWorkspacesConnectionStatusRequest:
type: object
title: DescribeWorkspacesConnectionStatusRequest
properties:
WorkspaceIds:
allOf:
- $ref: '#/components/schemas/WorkspaceIdList'
- description: The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
CreateStandbyWorkspacesRequest:
type: object
required:
- PrimaryRegion
- StandbyWorkspaces
title: CreateStandbyWorkspacesRequest
properties:
PrimaryRegion:
allOf:
- $ref: '#/components/schemas/Region'
- description: The Region of the primary WorkSpace.
StandbyWorkspaces:
allOf:
- $ref: '#/components/schemas/StandbyWorkspacesList'
- description: Information about the standby WorkSpace to be created.
BundleIdList:
type: array
items:
$ref: '#/components/schemas/BundleId'
minItems: 1
maxItems: 25
WorkspacesIpGroup:
type: object
properties:
groupId:
allOf:
- $ref: '#/components/schemas/IpGroupId'
- description: The identifier of the group.
groupName:
allOf:
- $ref: '#/components/schemas/IpGroupName'
- description: The name of the group.
groupDesc:
allOf:
- $ref: '#/components/schemas/IpGroupDesc'
- description: The description of the group.
userRules:
allOf:
- $ref: '#/components/schemas/IpRuleList'
- description: The rules.
description: Describes an IP access control group.
CreateUpdatedWorkspaceImageRequest:
type: object
required:
- Name
- Description
- SourceImageId
title: CreateUpdatedWorkspaceImageRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/WorkspaceImageName'
- description: The name of the new updated WorkSpace image.
Description:
allOf:
- $ref: '#/components/schemas/WorkspaceImageDescription'
- description: A description of whether updates for the WorkSpace image are available.
SourceImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the source WorkSpace image.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description:
The tags that you want to add to the new updated WorkSpace image.
To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
The SAML properties to delete as part of your request.
Specify one of the following options:
SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.
SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.
The IP address range, specified as an IPv4 CIDR block, used for the management network interface.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
ListAvailableManagementCidrRangesRequest: type: object required: - ManagementCidrRangeConstraint title: ListAvailableManagementCidrRangesRequest properties: ManagementCidrRangeConstraint: allOf: - $ref: '#/components/schemas/ManagementCidrRangeConstraint' - description: The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). MaxResults: allOf: - $ref: '#/components/schemas/ManagementCidrRangeMaxResults' - description: The maximum number of items to return. NextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: If you received aNextToken from a previous call that was paginated, provide this token to receive the next set of results.
Application:
type: string
enum:
- Microsoft_Office_2016
- Microsoft_Office_2019
ManagementCidrRangeConstraint:
type: string
pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$
IpGroupId:
type: string
pattern: wsipg-[0-9a-z]{8,63}$
RegisterWorkspaceDirectoryRequest:
type: object
required:
- DirectoryId
- EnableWorkDocs
title: RegisterWorkspaceDirectoryRequest
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.
SubnetIds:
allOf:
- $ref: '#/components/schemas/SubnetIds'
- description: The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.
EnableWorkDocs:
allOf:
- $ref: '#/components/schemas/BooleanObject'
- description: Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.
EnableSelfService:
allOf:
- $ref: '#/components/schemas/BooleanObject'
- description: Indicates whether self-service capabilities are enabled or disabled.
Tenancy:
allOf:
- $ref: '#/components/schemas/Tenancy'
- description: Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags associated with the directory.
BundleType:
type: string
enum:
- REGULAR
- STANDBY
DefaultLogo:
type: string
minLength: 1
maxLength: 1500000
BundleList:
type: array
items:
$ref: '#/components/schemas/WorkspaceBundle'
RelatedWorkspaces:
type: array
items:
$ref: '#/components/schemas/RelatedWorkspaceProperties'
AuthorizeIpRulesResult:
type: object
properties: {}
StopRequest:
type: object
properties:
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace.
description: Describes the information used to stop a WorkSpace.
ResourceAlreadyExistsException: {}
DescribeWorkspacesConnectionStatusResult:
type: object
properties:
WorkspacesConnectionStatus:
allOf:
- $ref: '#/components/schemas/WorkspaceConnectionStatusList'
- description: Information about the connection status of the WorkSpace.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
Snapshot:
type: object
properties:
SnapshotTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the snapshot was created.
description: Describes a snapshot.
WorkspaceImageState:
type: string
enum:
- AVAILABLE
- PENDING
- ERROR
ModifySelfservicePermissionsResult:
type: object
properties: {}
TargetWorkspaceState:
type: string
enum:
- AVAILABLE
- ADMIN_MAINTENANCE
ResourceNotFoundException: {}
WorkspaceBundle:
type: object
properties:
BundleId:
allOf:
- $ref: '#/components/schemas/BundleId'
- description: The identifier of the bundle.
Name:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The name of the bundle.
Owner:
allOf:
- $ref: '#/components/schemas/BundleOwner'
- description: The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by Amazon Web Services.
Description:
allOf:
- $ref: '#/components/schemas/Description'
- description: The description of the bundle.
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the image that was used to create the bundle.
RootStorage:
allOf:
- $ref: '#/components/schemas/RootStorage'
- description: The size of the root volume.
UserStorage:
allOf:
- $ref: '#/components/schemas/UserStorage'
- description: The size of the user volume.
ComputeType:
allOf:
- $ref: '#/components/schemas/ComputeType'
- description: The compute type of the bundle. For more information, see Amazon WorkSpaces Bundles.
LastUpdatedTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The last time that the bundle was updated.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the bundle was created.
State:
allOf:
- $ref: '#/components/schemas/WorkspaceBundleState'
- description: The state of the WorkSpace bundle.
BundleType:
allOf:
- $ref: '#/components/schemas/BundleType'
- description: The type of WorkSpace bundle.
description: Describes a WorkSpace bundle.
SamlUserAccessUrl:
type: string
pattern: ^(http|https)\://\S+$
minLength: 8
maxLength: 200
DedicatedTenancyModificationStateEnum:
type: string
enum:
- PENDING
- COMPLETED
- FAILED
DeregisterWorkspaceDirectoryResult:
type: object
properties: {}
DeleteIpGroupResult:
type: object
properties: {}
WorkspaceBundleDescription:
type: string
pattern: ^[a-zA-Z0-9_./() -]+$
minLength: 1
maxLength: 255
NonEmptyString:
type: string
minLength: 1
WorkspaceAccessProperties:
type: object
properties:
DeviceTypeWindows:
allOf:
- $ref: '#/components/schemas/AccessPropertyValue'
- description: Indicates whether users can use Windows clients to access their WorkSpaces.
DeviceTypeOsx:
allOf:
- $ref: '#/components/schemas/AccessPropertyValue'
- description: Indicates whether users can use macOS clients to access their WorkSpaces.
DeviceTypeWeb:
allOf:
- $ref: '#/components/schemas/AccessPropertyValue'
- description: Indicates whether users can access their WorkSpaces through a web browser.
DeviceTypeIos:
allOf:
- $ref: '#/components/schemas/AccessPropertyValue'
- description: Indicates whether users can use iOS devices to access their WorkSpaces.
DeviceTypeAndroid:
allOf:
- $ref: '#/components/schemas/AccessPropertyValue'
- description: Indicates whether users can use Android and Android-compatible Chrome OS devices to access their WorkSpaces.
DeviceTypeChromeOs:
allOf:
- $ref: '#/components/schemas/AccessPropertyValue'
- description: Indicates whether users can use Chromebooks to access their WorkSpaces.
DeviceTypeZeroClient:
allOf:
- $ref: '#/components/schemas/AccessPropertyValue'
- description: Indicates whether users can use zero client devices to access their WorkSpaces.
DeviceTypeLinux:
allOf:
- $ref: '#/components/schemas/AccessPropertyValue'
- description: Indicates whether users can use Linux clients to access their WorkSpaces.
description: The device types and operating systems that can be used to access a WorkSpace. For more information, see Amazon WorkSpaces Client Network Requirements.
CreateWorkspacesRequest:
type: object
required:
- Workspaces
title: CreateWorkspacesRequest
properties:
Workspaces:
allOf:
- $ref: '#/components/schemas/WorkspaceRequestList'
- description: The WorkSpaces to create. You can specify up to 25 WorkSpaces.
DisassociateIpGroupsResult:
type: object
properties: {}
WorkspaceImage:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the image.
Name:
allOf:
- $ref: '#/components/schemas/WorkspaceImageName'
- description: The name of the image.
Description:
allOf:
- $ref: '#/components/schemas/WorkspaceImageDescription'
- description: The description of the image.
OperatingSystem:
allOf:
- $ref: '#/components/schemas/OperatingSystem'
- description: 'The operating system that the image is running. '
State:
allOf:
- $ref: '#/components/schemas/WorkspaceImageState'
- description: The status of the image.
RequiredTenancy:
allOf:
- $ref: '#/components/schemas/WorkspaceImageRequiredTenancy'
- description: Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
ErrorCode:
allOf:
- $ref: '#/components/schemas/WorkspaceImageErrorCode'
- description: The error code that is returned for the image.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/Description'
- description: The text of the error message that is returned for the image.
Created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date when the image was created. If the image has been shared, the Amazon Web Services account that the image has been shared with sees the original creation date of the image.
OwnerAccountId:
allOf:
- $ref: '#/components/schemas/AwsAccount'
- description: The identifier of the Amazon Web Services account that owns the image.
Updates:
allOf:
- $ref: '#/components/schemas/UpdateResult'
- description: The updates (if any) that are available for the specified image.
description: Describes a WorkSpace image.
OperatingSystem:
type: object
properties:
Type:
allOf:
- $ref: '#/components/schemas/OperatingSystemType'
- description: The operating system.
description: The operating system that the image is running.
ModifyWorkspaceAccessPropertiesRequest:
type: object
required:
- ResourceId
- WorkspaceAccessProperties
title: ModifyWorkspaceAccessPropertiesRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory.
WorkspaceAccessProperties:
allOf:
- $ref: '#/components/schemas/WorkspaceAccessProperties'
- description: The device types and operating systems to enable or disable for access.
ConnectionIdentifier:
type: string
pattern: ^[a-zA-Z0-9]+$
minLength: 1
maxLength: 20
FailedCreateWorkspaceRequest:
type: object
properties:
WorkspaceRequest:
allOf:
- $ref: '#/components/schemas/WorkspaceRequest'
- description: Information about the WorkSpace.
ErrorCode:
allOf:
- $ref: '#/components/schemas/ErrorType'
- description: The error code that is returned if the WorkSpace cannot be created.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/Description'
- description: The text of the error message that is returned if the WorkSpace cannot be created.
description: Describes a WorkSpace that cannot be created.
UpdateRulesOfIpGroupResult:
type: object
properties: {}
PaginationToken:
type: string
minLength: 1
maxLength: 2048
RebuildWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/RebuildRequest'
minItems: 1
maxItems: 1
RebootWorkspacesRequest:
type: object
required:
- RebootWorkspaceRequests
title: RebootWorkspacesRequest
properties:
RebootWorkspaceRequests:
allOf:
- $ref: '#/components/schemas/RebootWorkspaceRequests'
- description: The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.
InvalidResourceStateException: {}
FailedCreateWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedCreateWorkspaceRequest'
IpRevokedRuleList:
type: array
items:
$ref: '#/components/schemas/IpRule'
ModificationState:
type: object
properties:
Resource:
allOf:
- $ref: '#/components/schemas/ModificationResourceEnum'
- description: The resource.
State:
allOf:
- $ref: '#/components/schemas/ModificationStateEnum'
- description: The modification state.
description: Describes a WorkSpace modification.
DeleteClientBrandingRequest:
type: object
required:
- ResourceId
- Platforms
title: DeleteClientBrandingRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier of the WorkSpace for which you want to delete client branding.
Platforms:
allOf:
- $ref: '#/components/schemas/ClientDeviceTypeList'
- description: The device type for which you want to delete client branding.
DescribeIpGroupsRequest:
type: object
title: DescribeIpGroupsRequest
properties:
GroupIds:
allOf:
- $ref: '#/components/schemas/IpGroupIdList'
- description: The identifiers of one or more IP access control groups.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/Limit'
- description: The maximum number of items to return.
ModifyClientPropertiesRequest:
type: object
required:
- ResourceId
- ClientProperties
title: ModifyClientPropertiesRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The resource identifiers, in the form of directory IDs.
ClientProperties:
allOf:
- $ref: '#/components/schemas/ClientProperties'
- description: Information about the Amazon WorkSpaces client.
DeregisterWorkspaceDirectoryRequest:
type: object
required:
- DirectoryId
title: DeregisterWorkspaceDirectoryRequest
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.
BundleId:
type: string
pattern: ^wsb-[0-9a-z]{8,63}$
RestoreWorkspaceResult:
type: object
properties: {}
ModifyAccountRequest:
type: object
title: ModifyAccountRequest
properties:
DedicatedTenancySupport:
allOf:
- $ref: '#/components/schemas/DedicatedTenancySupportEnum'
- description: The status of BYOL.
DedicatedTenancyManagementCidrRange:
allOf:
- $ref: '#/components/schemas/DedicatedTenancyManagementCidrRange'
- description: The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.
TerminateWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/TerminateRequest'
minItems: 1
maxItems: 25
DeleteWorkspaceImageRequest:
type: object
required:
- ImageId
title: DeleteWorkspaceImageRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the image.
CreateConnectClientAddInRequest:
type: object
required:
- ResourceId
- Name
- URL
title: CreateConnectClientAddInRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier for which to configure the client add-in.
Name:
allOf:
- $ref: '#/components/schemas/AddInName'
- description: The name of the client add-in.
URL:
allOf:
- $ref: '#/components/schemas/AddInUrl'
- description: The endpoint URL of the Amazon Connect client add-in.
ModifyWorkspaceCreationPropertiesResult:
type: object
properties: {}
DescribeConnectionAliasesResult:
type: object
properties:
ConnectionAliases:
allOf:
- $ref: '#/components/schemas/ConnectionAliasList'
- description: Information about the specified connection aliases.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
DescribeWorkspaceImagePermissionsResult:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the image.
ImagePermissions:
allOf:
- $ref: '#/components/schemas/ImagePermissions'
- description: The identifiers of the Amazon Web Services accounts that the image has been shared with.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
FailedCreateStandbyWorkspacesRequestList:
type: array
items:
$ref: '#/components/schemas/FailedCreateStandbyWorkspacesRequest'
WorkspaceImageRequiredTenancy:
type: string
enum:
- DEFAULT
- DEDICATED
TerminateWorkspacesResult:
type: object
properties:
FailedRequests:
allOf:
- $ref: '#/components/schemas/FailedTerminateWorkspaceRequests'
- description: Information about the WorkSpaces that could not be terminated.
RevokeIpRulesResult:
type: object
properties: {}
TagKeyList:
type: array
items:
$ref: '#/components/schemas/NonEmptyString'
IpGroupName:
type: string
FailedRebootWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
ModifyWorkspacePropertiesRequest:
type: object
required:
- WorkspaceId
- WorkspaceProperties
title: ModifyWorkspacePropertiesRequest
properties:
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace.
WorkspaceProperties:
allOf:
- $ref: '#/components/schemas/WorkspaceProperties'
- description: The properties of the WorkSpace.
CreateTagsResult:
type: object
properties: {}
DeleteConnectClientAddInRequest:
type: object
required:
- AddInId
- ResourceId
title: DeleteConnectClientAddInRequest
properties:
AddInId:
allOf:
- $ref: '#/components/schemas/AmazonUuid'
- description: The identifier of the client add-in to delete.
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier for which the client add-in is configured.
WorkspaceConnectionStatusList:
type: array
items:
$ref: '#/components/schemas/WorkspaceConnectionStatus'
ConnectionAliasIdList:
type: array
items:
$ref: '#/components/schemas/ConnectionAliasId'
minItems: 1
maxItems: 25
InvalidParameterValuesException: {}
AssociateIpGroupsRequest:
type: object
required:
- DirectoryId
- GroupIds
title: AssociateIpGroupsRequest
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory.
GroupIds:
allOf:
- $ref: '#/components/schemas/IpGroupIdList'
- description: The identifiers of one or more IP access control groups.
Compute:
type: string
enum:
- VALUE
- STANDARD
- PERFORMANCE
- POWER
- GRAPHICS
- POWERPRO
- GRAPHICSPRO
- GRAPHICS_G4DN
- GRAPHICSPRO_G4DN
DeletableCertificateBasedAuthProperty:
type: string
enum:
- CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN
ModifySamlPropertiesResult:
type: object
properties: {}
StopWorkspacesRequest:
type: object
required:
- StopWorkspaceRequests
title: StopWorkspacesRequest
properties:
StopWorkspaceRequests:
allOf:
- $ref: '#/components/schemas/StopWorkspaceRequests'
- description: The WorkSpaces to stop. You can specify up to 25 WorkSpaces.
DescribeWorkspaceImagePermissionsRequest:
type: object
required:
- ImageId
title: DescribeWorkspaceImagePermissionsRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the image.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/Limit'
- description: The maximum number of items to return.
ResourceLimitExceededException: {}
ModifyClientPropertiesResult:
type: object
properties: {}
UpdateWorkspaceBundleRequest:
type: object
title: UpdateWorkspaceBundleRequest
properties:
BundleId:
allOf:
- $ref: '#/components/schemas/BundleId'
- description: The identifier of the bundle.
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the image.
IosImportClientBrandingAttributes:
type: object
properties:
Logo:
allOf:
- $ref: '#/components/schemas/IosLogo'
- description: The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.
Logo2x:
allOf:
- $ref: '#/components/schemas/Ios2XLogo'
- description: The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The support email. The company's customer support email address.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.
en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.'
description: The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.
Client branding attributes are public facing. Ensure you do not include sensitive information.
Information about the WorkSpaces that were created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
AssociateConnectionAliasRequest: type: object required: - AliasId - ResourceId title: AssociateConnectionAliasRequest properties: AliasId: allOf: - $ref: '#/components/schemas/ConnectionAliasId' - description: The identifier of the connection alias. ResourceId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The identifier of the directory to associate the connection alias with. WorkspaceImageList: type: array items: $ref: '#/components/schemas/WorkspaceImage' StandbyWorkspacesList: type: array items: $ref: '#/components/schemas/StandbyWorkspace' ImagePermissions: type: array items: $ref: '#/components/schemas/ImagePermission' CreateStandbyWorkspacesResult: type: object properties: FailedStandbyRequests: allOf: - $ref: '#/components/schemas/FailedCreateStandbyWorkspacesRequestList' - description: 'Information about the standby WorkSpace that could not be created. ' PendingStandbyRequests: allOf: - $ref: '#/components/schemas/PendingCreateStandbyWorkspacesRequestList' - description: Information about the standby WorkSpace that was created. TagValue: type: string maxLength: 255 Limit: type: integer minimum: 1 maximum: 25 UpdateWorkspaceImagePermissionRequest: type: object required: - ImageId - AllowCopyImage - SharedAccountId title: UpdateWorkspaceImagePermissionRequest properties: ImageId: allOf: - $ref: '#/components/schemas/WorkspaceImageId' - description: The identifier of the image. AllowCopyImage: allOf: - $ref: '#/components/schemas/BooleanObject' - description: The permission to copy the image. This permission can be revoked only after an image has been shared. SharedAccountId: allOf: - $ref: '#/components/schemas/AwsAccount' - description:The identifier of the Amazon Web Services account to share or unshare the image with.
Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.
DefaultClientBrandingAttributes:
type: object
properties:
LogoUrl:
allOf:
- $ref: '#/components/schemas/ClientUrl'
- description: The logo. The only image format accepted is a binary data object that is converted from a .png file.
SupportEmail:
allOf:
- $ref: '#/components/schemas/ClientEmail'
- description: The support email. The company's customer support email address.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.
en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.'
description: Returns default client branding attributes that were imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you don't include sensitive information.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.
ResourceCreationFailedException: {}
RevokeIpRulesRequest:
type: object
required:
- GroupId
- UserRules
title: RevokeIpRulesRequest
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/IpGroupId'
- description: The identifier of the group.
UserRules:
allOf:
- $ref: '#/components/schemas/IpRevokedRuleList'
- description: The rules to remove from the group.
RegistrationCode:
type: string
minLength: 1
maxLength: 20
ConnectionAlias:
type: object
properties:
ConnectionString:
allOf:
- $ref: '#/components/schemas/ConnectionString'
- description: The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com.
AliasId:
allOf:
- $ref: '#/components/schemas/ConnectionAliasId'
- description: The identifier of the connection alias.
State:
allOf:
- $ref: '#/components/schemas/ConnectionAliasState'
- description: The current state of the connection alias.
OwnerAccountId:
allOf:
- $ref: '#/components/schemas/AwsAccount'
- description: The identifier of the Amazon Web Services account that owns the connection alias.
Associations:
allOf:
- $ref: '#/components/schemas/ConnectionAliasAssociationList'
- description: The association status of the connection alias.
description: Describes a connection alias. Connection aliases are used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
DescribeTagsResult:
type: object
properties:
TagList:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags.
MigrateWorkspaceResult:
type: object
properties:
SourceWorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The original identifier of the WorkSpace that is being migrated.
TargetWorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The new identifier of the WorkSpace that is being migrated. If the migration does not succeed, the target WorkSpace ID will not be used, and the WorkSpace will still have the original WorkSpace ID.
Tenancy:
type: string
enum:
- DEDICATED
- SHARED
DescribeTagsRequest:
type: object
required:
- ResourceId
title: DescribeTagsRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
WorkspaceBundleState:
type: string
enum:
- AVAILABLE
- PENDING
- ERROR
SamlStatusEnum:
type: string
enum:
- DISABLED
- ENABLED
- ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
Ios3XLogo:
type: string
minLength: 1
maxLength: 1770000
ClientPropertiesResult:
type: object
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The resource identifier, in the form of a directory ID.
ClientProperties:
allOf:
- $ref: '#/components/schemas/ClientProperties'
- description: Information about the Amazon WorkSpaces client.
description: Information about the Amazon WorkSpaces client.
DescribeWorkspaceSnapshotsRequest:
type: object
required:
- WorkspaceId
title: DescribeWorkspaceSnapshotsRequest
properties:
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace.
ConnectionString:
type: string
pattern: ^[.0-9a-zA-Z\-]{1,255}$
minLength: 1
maxLength: 255
IpRuleDesc:
type: string
ImportWorkspaceImageRequest:
type: object
required:
- Ec2ImageId
- IngestionProcess
- ImageName
- ImageDescription
title: ImportWorkspaceImageRequest
properties:
Ec2ImageId:
allOf:
- $ref: '#/components/schemas/Ec2ImageId'
- description: The identifier of the EC2 image.
IngestionProcess:
allOf:
- $ref: '#/components/schemas/WorkspaceImageIngestionProcess'
- description: The ingestion process to be used when importing the image, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.
For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.
The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.
If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.
Although this parameter is an array, only one item is allowed at this time.
Windows 11 only supports Microsoft_Office_2019.
The running mode. For more information, see Manage the WorkSpace Running Mode.
The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.
The protocol. For more information, see Protocols for Amazon WorkSpaces.
Only available for WorkSpaces created with PCoIP bundles.
The Protocols property is case sensitive. Ensure you use PCOIP or WSP.
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
Describes the standby WorkSpace that was created.
Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.
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. Ios2XLogo: type: string minLength: 1 maxLength: 1770000 DescribeClientBrandingRequest: type: object required: - ResourceId title: DescribeClientBrandingRequest properties: ResourceId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The directory identifier of the WorkSpace for which you want to view client branding information. ConnectionAliasId: type: string pattern: ^wsca-[0-9a-z]{8,63}$ minLength: 13 maxLength: 68 RelatedWorkspaceProperties: type: object properties: WorkspaceId: allOf: - $ref: '#/components/schemas/WorkspaceId' - description: The identifier of the related WorkSpace. Region: allOf: - $ref: '#/components/schemas/Region' - description: The Region of the related WorkSpace. State: allOf: - $ref: '#/components/schemas/WorkspaceState' - description: Indicates the state of the WorkSpace. Type: allOf: - $ref: '#/components/schemas/StandbyWorkspaceRelationshipType' - description: Indicates the type of WorkSpace. description: Describes the related WorkSpace. The related WorkSpace could be a standby WorkSpace or primary WorkSpace related to the specified WorkSpace. CreateConnectionAliasRequest: type: object required: - ConnectionString title: CreateConnectionAliasRequest properties: ConnectionString: allOf: - $ref: '#/components/schemas/ConnectionString' - description:A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.
After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.
Information about the WorkSpaces.
Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.
NextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. ' DisassociateConnectionAliasRequest: type: object required: - AliasId title: DisassociateConnectionAliasRequest properties: AliasId: allOf: - $ref: '#/components/schemas/ConnectionAliasId' - description: The identifier of the connection alias to disassociate. ClientLoginMessage: type: string pattern: ^.*$ minLength: 0 maxLength: 2000 WorkspaceRequest: type: object required: - DirectoryId - UserName - BundleId properties: DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories. UserName: allOf: - $ref: '#/components/schemas/UserName' - description: The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace. BundleId: allOf: - $ref: '#/components/schemas/BundleId' - description: The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles. VolumeEncryptionKey: allOf: - $ref: '#/components/schemas/VolumeEncryptionKey' - description: The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys. UserVolumeEncryptionEnabled: allOf: - $ref: '#/components/schemas/BooleanObject' - description: Indicates whether the data stored on the user volume is encrypted. RootVolumeEncryptionEnabled: allOf: - $ref: '#/components/schemas/BooleanObject' - description: Indicates whether the data stored on the root volume is encrypted. WorkspaceProperties: allOf: - $ref: '#/components/schemas/WorkspaceProperties' - description: The WorkSpace properties. Tags: allOf: - $ref: '#/components/schemas/TagList' - description: The tags for the WorkSpace. description: Describes the information used to create a WorkSpace. DeleteClientBrandingResult: type: object properties: {} DescribeConnectionAliasPermissionsRequest: type: object required: - AliasId title: DescribeConnectionAliasPermissionsRequest properties: AliasId: allOf: - $ref: '#/components/schemas/ConnectionAliasId' - description: The identifier of the connection alias. NextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: 'If you received aNextToken from a previous call that was paginated, provide this token to receive the next set of results. '
MaxResults:
allOf:
- $ref: '#/components/schemas/Limit'
- description: The maximum number of results to return.
CreateWorkspaceBundleResult:
type: object
properties:
WorkspaceBundle:
$ref: '#/components/schemas/WorkspaceBundle'
ProtocolList:
type: array
items:
$ref: '#/components/schemas/Protocol'
AssociateConnectionAliasResult:
type: object
properties:
ConnectionIdentifier:
allOf:
- $ref: '#/components/schemas/ConnectionIdentifier'
- description: 'The identifier of the connection alias association. You use the connection identifier in the DNS TXT record when you''re configuring your DNS routing policies. '
Tag:
type: object
required:
- Key
properties:
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The key of the tag.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The value of the tag.
description: Describes a tag.
WorkspaceErrorCode:
type: string
Protocol:
type: string
enum:
- PCOIP
- WSP
UpdateResult:
type: object
properties:
UpdateAvailable:
allOf:
- $ref: '#/components/schemas/BooleanObject'
- description: Indicates whether updated drivers or other components are available for the specified WorkSpace image.
Description:
allOf:
- $ref: '#/components/schemas/UpdateDescription'
- description: A description of whether updates for the WorkSpace image are pending or available.
description: Describes whether a WorkSpace image needs to be updated with the latest drivers and other components required by Amazon WorkSpaces.
Only Windows 10 WorkSpace images can be programmatically updated at this time.
.png file.
Logo2xUrl:
allOf:
- $ref: '#/components/schemas/ClientUrl'
- description: The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x).The only image format accepted is a binary data object that is converted from a .png file.
For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.
The support email. The company's customer support email address.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.
en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.'
description: The client branding attributes for iOS device types. These attributes are displayed on the iOS client login screen only.
Client branding attributes are public facing. Ensure you do not include sensitive information.
Indicates the status of SAML 2.0 authentication. These statuses include the following.
If the setting is DISABLED, end users will be directed to login with their directory credentials.
If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
description: Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider. LogUploadEnum: type: string enum: - ENABLED - DISABLED UnsupportedWorkspaceConfigurationException: {} AddInUrl: type: string pattern: ^(http|https)\://\S+ minLength: 1 maxLength: 1024 DescribeConnectionAliasesRequest: type: object title: DescribeConnectionAliasesRequest properties: AliasIds: allOf: - $ref: '#/components/schemas/ConnectionAliasIdList' - description: The identifiers of the connection aliases to describe. ResourceId: allOf: - $ref: '#/components/schemas/NonEmptyString' - description: The identifier of the directory associated with the connection alias. Limit: allOf: - $ref: '#/components/schemas/Limit' - description: The maximum number of connection aliases to return. NextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: 'If you received aNextToken from a previous call that was paginated, provide this token to receive the next set of results. '
ConnectionState:
type: string
enum:
- CONNECTED
- DISCONNECTED
- UNKNOWN
ModificationStateList:
type: array
items:
$ref: '#/components/schemas/ModificationState'
DeletableSamlProperty:
type: string
enum:
- SAML_PROPERTIES_USER_ACCESS_URL
- SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
RebootRequest:
type: object
required:
- WorkspaceId
properties:
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace.
description: Describes the information used to reboot a WorkSpace.
ImportClientBrandingResult:
type: object
properties:
DeviceTypeWindows:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information configured for Windows devices.
DeviceTypeOsx:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information configured for macOS devices.
DeviceTypeAndroid:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information configured for Android devices.
DeviceTypeIos:
allOf:
- $ref: '#/components/schemas/IosClientBrandingAttributes'
- description: The branding information configured for iOS devices.
DeviceTypeLinux:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information configured for Linux devices.
DeviceTypeWeb:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information configured for web access.
ImportClientBrandingRequest:
type: object
required:
- ResourceId
title: ImportClientBrandingRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier of the WorkSpace for which you want to import client branding.
DeviceTypeWindows:
allOf:
- $ref: '#/components/schemas/DefaultImportClientBrandingAttributes'
- description: The branding information to import for Windows devices.
DeviceTypeOsx:
allOf:
- $ref: '#/components/schemas/DefaultImportClientBrandingAttributes'
- description: The branding information to import for macOS devices.
DeviceTypeAndroid:
allOf:
- $ref: '#/components/schemas/DefaultImportClientBrandingAttributes'
- description: The branding information to import for Android devices.
DeviceTypeIos:
allOf:
- $ref: '#/components/schemas/IosImportClientBrandingAttributes'
- description: The branding information to import for iOS devices.
DeviceTypeLinux:
allOf:
- $ref: '#/components/schemas/DefaultImportClientBrandingAttributes'
- description: The branding information to import for Linux devices.
DeviceTypeWeb:
allOf:
- $ref: '#/components/schemas/DefaultImportClientBrandingAttributes'
- description: The branding information to import for web access.
ModifyWorkspacePropertiesResult:
type: object
properties: {}
SubnetId:
type: string
pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$
minLength: 15
maxLength: 24
AccountModification:
type: object
properties:
ModificationState:
allOf:
- $ref: '#/components/schemas/DedicatedTenancyModificationStateEnum'
- description: The state of the modification to the configuration of BYOL.
DedicatedTenancySupport:
allOf:
- $ref: '#/components/schemas/DedicatedTenancySupportResultEnum'
- description: The status of BYOL (whether BYOL is being enabled or disabled).
DedicatedTenancyManagementCidrRange:
allOf:
- $ref: '#/components/schemas/DedicatedTenancyManagementCidrRange'
- description: The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The timestamp when the modification of the BYOL configuration was started.
ErrorCode:
allOf:
- $ref: '#/components/schemas/WorkspaceErrorCode'
- description: The error code that is returned if the configuration of BYOL cannot be modified.
ErrorMessage:
allOf:
- $ref: '#/components/schemas/Description'
- description: The text of the error message that is returned if the configuration of BYOL cannot be modified.
description: 'Describes a modification to the configuration of Bring Your Own License (BYOL) for the specified account. '
DescribeConnectClientAddInsRequest:
type: object
required:
- ResourceId
title: DescribeConnectClientAddInsRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier for which the client add-in is configured.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/Limit'
- description: The maximum number of items to return.
CreateWorkspaceImageRequest:
type: object
required:
- Name
- Description
- WorkspaceId
title: CreateWorkspaceImageRequest
properties:
Name:
allOf:
- $ref: '#/components/schemas/WorkspaceImageName'
- description: The name of the new WorkSpace image.
Description:
allOf:
- $ref: '#/components/schemas/WorkspaceImageDescription'
- description: The description of the new WorkSpace image.
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the source WorkSpace
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.
WorkspaceId:
type: string
pattern: ^ws-[0-9a-z]{8,63}$
FailedRebuildWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
MigrateWorkspaceRequest:
type: object
required:
- SourceWorkspaceId
- BundleId
title: MigrateWorkspaceRequest
properties:
SourceWorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace to migrate from.
BundleId:
allOf:
- $ref: '#/components/schemas/BundleId'
- description: The identifier of the target bundle type to migrate the WorkSpace to.
DirectoryIdList:
type: array
items:
$ref: '#/components/schemas/DirectoryId'
minItems: 1
maxItems: 25
ConnectClientAddInList:
type: array
items:
$ref: '#/components/schemas/ConnectClientAddIn'
CreateWorkspaceImageResult:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the new WorkSpace image.
Name:
allOf:
- $ref: '#/components/schemas/WorkspaceImageName'
- description: The name of the image.
Description:
allOf:
- $ref: '#/components/schemas/WorkspaceImageDescription'
- description: The description of the image.
OperatingSystem:
allOf:
- $ref: '#/components/schemas/OperatingSystem'
- description: The operating system that the image is running.
State:
allOf:
- $ref: '#/components/schemas/WorkspaceImageState'
- description: The availability status of the image.
RequiredTenancy:
allOf:
- $ref: '#/components/schemas/WorkspaceImageRequiredTenancy'
- description: Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images..
Created:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date when the image was created.
OwnerAccountId:
allOf:
- $ref: '#/components/schemas/AwsAccount'
- description: The identifier of the Amazon Web Services account that owns the image.
AccountModificationList:
type: array
items:
$ref: '#/components/schemas/AccountModification'
DeleteWorkspaceBundleResult:
type: object
properties: {}
DeleteTagsResult:
type: object
properties: {}
DeletableSamlPropertiesList:
type: array
items:
$ref: '#/components/schemas/DeletableSamlProperty'
ModifyWorkspaceAccessPropertiesResult:
type: object
properties: {}
DeleteTagsRequest:
type: object
required:
- ResourceId
- TagKeys
title: DeleteTagsRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.
TagKeys:
allOf:
- $ref: '#/components/schemas/TagKeyList'
- description: The tag keys.
WorkspaceBundleName:
type: string
pattern: ^[a-zA-Z0-9_./()\\-]+$
minLength: 1
maxLength: 64
RootVolumeSizeGib:
type: integer
TagKey:
type: string
minLength: 1
maxLength: 127
DescribeWorkspaceBundlesResult:
type: object
properties:
Bundles:
allOf:
- $ref: '#/components/schemas/BundleList'
- description: Information about the bundles.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.
RebuildWorkspacesResult:
type: object
properties:
FailedRequests:
allOf:
- $ref: '#/components/schemas/FailedRebuildWorkspaceRequests'
- description: Information about the WorkSpace that could not be rebuilt.
WorkspaceDirectory:
type: object
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier.
Alias:
allOf:
- $ref: '#/components/schemas/Alias'
- description: The directory alias.
DirectoryName:
allOf:
- $ref: '#/components/schemas/DirectoryName'
- description: The name of the directory.
RegistrationCode:
allOf:
- $ref: '#/components/schemas/RegistrationCode'
- description: The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
SubnetIds:
allOf:
- $ref: '#/components/schemas/SubnetIds'
- description: The identifiers of the subnets used with the directory.
DnsIpAddresses:
allOf:
- $ref: '#/components/schemas/DnsIpAddresses'
- description: The IP addresses of the DNS servers for the directory.
CustomerUserName:
allOf:
- $ref: '#/components/schemas/UserName'
- description: The user name for the service account.
IamRoleId:
allOf:
- $ref: '#/components/schemas/ARN'
- description: The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.
DirectoryType:
allOf:
- $ref: '#/components/schemas/WorkspaceDirectoryType'
- description: The directory type.
WorkspaceSecurityGroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- description: The identifier of the security group that is assigned to new WorkSpaces.
State:
allOf:
- $ref: '#/components/schemas/WorkspaceDirectoryState'
- description: The state of the directory's registration with Amazon WorkSpaces. After a directory is deregistered, the DEREGISTERED state is returned very briefly before the directory metadata is cleaned up, so this state is rarely returned. To confirm that a directory is deregistered, check for the directory ID by using DescribeWorkspaceDirectories. If the directory ID isn't returned, then the directory has been successfully deregistered.
WorkspaceCreationProperties:
allOf:
- $ref: '#/components/schemas/DefaultWorkspaceCreationProperties'
- description: The default creation properties for all WorkSpaces in the directory.
ipGroupIds:
allOf:
- $ref: '#/components/schemas/IpGroupIdList'
- description: The identifiers of the IP access control groups associated with the directory.
WorkspaceAccessProperties:
allOf:
- $ref: '#/components/schemas/WorkspaceAccessProperties'
- description: The devices and operating systems that users can use to access WorkSpaces.
Tenancy:
allOf:
- $ref: '#/components/schemas/Tenancy'
- description: Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
SelfservicePermissions:
allOf:
- $ref: '#/components/schemas/SelfservicePermissions'
- description: The default self-service permissions for WorkSpaces in the directory.
SamlProperties:
allOf:
- $ref: '#/components/schemas/SamlProperties'
- description: Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
CertificateBasedAuthProperties:
allOf:
- $ref: '#/components/schemas/CertificateBasedAuthProperties'
- description: The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
description: Describes a directory that is used with Amazon WorkSpaces.
DeleteWorkspaceBundleRequest:
type: object
title: DeleteWorkspaceBundleRequest
properties:
BundleId:
allOf:
- $ref: '#/components/schemas/BundleId'
- description: The identifier of the bundle.
UpdateConnectionAliasPermissionResult:
type: object
properties: {}
DisassociateIpGroupsRequest:
type: object
required:
- DirectoryId
- GroupIds
title: DisassociateIpGroupsRequest
properties:
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory.
GroupIds:
allOf:
- $ref: '#/components/schemas/IpGroupIdList'
- description: The identifiers of one or more IP access control groups.
DedicatedTenancySupportResultEnum:
type: string
enum:
- ENABLED
- DISABLED
DefaultImportClientBrandingAttributes:
type: object
properties:
Logo:
allOf:
- $ref: '#/components/schemas/DefaultLogo'
- description: The logo. The only image format accepted is a binary data object that is converted from a .png file.
SupportEmail:
allOf:
- $ref: '#/components/schemas/ClientEmail'
- description: The support email. The company's customer support email address.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default email is workspaces-feedback@amazon.com.
The support link. The link for the company's customer support page for their WorkSpace.
In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.
The default support link is workspaces-feedback@amazon.com.
en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.'
description: The default client branding attributes to be imported. These attributes display on the client login screen.
Client branding attributes are public facing. Ensure that you do not include sensitive information.
The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.
Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
DirectoryId: allOf: - $ref: '#/components/schemas/DirectoryId' - description: The identifier of the directory. In addition, you can optionally specify a specific directory user (seeUserName). 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 DirectoryId.
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 NextToken from a previous call that was paginated, provide this token to receive the next set of results.
ReconnectEnum:
type: string
enum:
- ENABLED
- DISABLED
DescribeWorkspaceBundlesRequest:
type: object
title: DescribeWorkspaceBundlesRequest
properties:
BundleIds:
allOf:
- $ref: '#/components/schemas/BundleIdList'
- description: The identifiers of the bundles. You cannot combine this parameter with any other filter.
Owner:
allOf:
- $ref: '#/components/schemas/BundleOwner'
- description: The owner of the bundles. You cannot combine this parameter with any other filter.
To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.
Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.
If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.
The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.
To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.
The API doesn't validate whether the OU exists.
The tags associated with the bundle.
To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.
The operational state of the WorkSpace.
After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.