Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.
You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.
' 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 externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/workspaces/' 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) x-hasEquivalentPaths: true paths: /#X-Amz-Target=WorkspacesService.AssociateConnectionAlias: 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.
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 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' /#X-Amz-Target=WorkspacesService.CopyWorkspaceImage: 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.
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 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' /#X-Amz-Target=WorkspacesService.CreateConnectionAlias: 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 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' /#X-Amz-Target=WorkspacesService.CreateIpGroup: 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 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' /#X-Amz-Target=WorkspacesService.CreateStandbyWorkspaces: 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 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' /#X-Amz-Target=WorkspacesService.CreateTags: 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 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' /#X-Amz-Target=WorkspacesService.CreateUpdatedWorkspaceImage: 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.
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.
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 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' /#X-Amz-Target=WorkspacesService.DeleteConnectClientAddIn: 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 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' /#X-Amz-Target=WorkspacesService.DeleteConnectionAlias: 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.
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 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' /#X-Amz-Target=WorkspacesService.DeleteTags: 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 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' /#X-Amz-Target=WorkspacesService.DeleteWorkspaceBundle: 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 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' /#X-Amz-Target=WorkspacesService.DeleteWorkspaceImage: 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 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' /#X-Amz-Target=WorkspacesService.DeregisterWorkspaceDirectory: 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.
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.
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 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' /#X-Amz-Target=WorkspacesService.DescribeWorkspaceDirectories: 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 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' /#X-Amz-Target=WorkspacesService.DescribeWorkspaceImagePermissions: 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 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' /#X-Amz-Target=WorkspacesService.DescribeWorkspaceImages: 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 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' /#X-Amz-Target=WorkspacesService.DescribeWorkspaceSnapshots: 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 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' /#X-Amz-Target=WorkspacesService.DescribeWorkspaces: 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 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' /#X-Amz-Target=WorkspacesService.DescribeWorkspacesConnectionStatus: 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 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' /#X-Amz-Target=WorkspacesService.DisassociateConnectionAlias: 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.
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.
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 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' /#X-Amz-Target=WorkspacesService.MigrateWorkspace: 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 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' /#X-Amz-Target=WorkspacesService.ModifyAccount: 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 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' /#X-Amz-Target=WorkspacesService.ModifyCertificateBasedAuthProperties: 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 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' /#X-Amz-Target=WorkspacesService.ModifyClientProperties: 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 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' /#X-Amz-Target=WorkspacesService.ModifySamlProperties: 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 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' /#X-Amz-Target=WorkspacesService.ModifySelfservicePermissions: 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 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' /#X-Amz-Target=WorkspacesService.ModifyWorkspaceAccessProperties: 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 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' /#X-Amz-Target=WorkspacesService.ModifyWorkspaceCreationProperties: 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 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' /#X-Amz-Target=WorkspacesService.ModifyWorkspaceProperties: 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.
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.
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 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' /#X-Amz-Target=WorkspacesService.RebuildWorkspaces: 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 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' /#X-Amz-Target=WorkspacesService.RegisterWorkspaceDirectory: 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 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' /#X-Amz-Target=WorkspacesService.RestoreWorkspace: 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 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' /#X-Amz-Target=WorkspacesService.RevokeIpRules: 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 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' /#X-Amz-Target=WorkspacesService.StartWorkspaces: 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.
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.
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.
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.
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.
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.
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.
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 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.
workspaces:CreateTags.'
CreateWorkspacesResult:
type: object
properties:
FailedRequests:
allOf:
- $ref: '#/components/schemas/FailedCreateWorkspaceRequests'
- description: Information about the WorkSpaces that could not be created.
PendingRequests:
allOf:
- $ref: '#/components/schemas/WorkspaceList'
- description: '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.
' 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. DeleteClientBrandingResult: type: object properties: {} 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. DeleteConnectClientAddInResult: 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. DeleteConnectionAliasResult: type: object properties: {} DeleteConnectionAliasRequest: type: object required: - AliasId title: DeleteConnectionAliasRequest properties: AliasId: allOf: - $ref: '#/components/schemas/ConnectionAliasId' - description: The identifier of the connection alias to delete. DeleteIpGroupResult: type: object properties: {} DeleteIpGroupRequest: type: object required: - GroupId title: DeleteIpGroupRequest properties: GroupId: allOf: - $ref: '#/components/schemas/IpGroupId' - description: The identifier of the IP access control group. DeleteTagsResult: 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. DeleteWorkspaceBundleResult: type: object properties: {} DeleteWorkspaceBundleRequest: type: object title: DeleteWorkspaceBundleRequest properties: BundleId: allOf: - $ref: '#/components/schemas/BundleId' - description: The identifier of the bundle. DeleteWorkspaceImageResult: type: object properties: {} DeleteWorkspaceImageRequest: type: object required: - ImageId title: DeleteWorkspaceImageRequest properties: ImageId: allOf: - $ref: '#/components/schemas/WorkspaceImageId' - description: The identifier of the image. DeregisterWorkspaceDirectoryResult: type: object properties: {} 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.' DescribeAccountResult: type: object properties: DedicatedTenancySupport: allOf: - $ref: '#/components/schemas/DedicatedTenancySupportResultEnum' - description: The status of BYOL (whether BYOL is enabled or disabled). DedicatedTenancyManagementCidrRange: allOf: - $ref: '#/components/schemas/DedicatedTenancyManagementCidrRange' - description: '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.
' DescribeAccountRequest: type: object title: DescribeAccountRequest properties: {} DescribeAccountModificationsResult: type: object properties: AccountModifications: allOf: - $ref: '#/components/schemas/AccountModificationList' - description: The list of modifications to the configuration of BYOL. 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. ' DescribeAccountModificationsRequest: type: object title: DescribeAccountModificationsRequest properties: 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.'
DescribeClientBrandingResult:
type: object
properties:
DeviceTypeWindows:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information for Windows devices.
DeviceTypeOsx:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information for macOS devices.
DeviceTypeAndroid:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information for Android devices.
DeviceTypeIos:
allOf:
- $ref: '#/components/schemas/IosClientBrandingAttributes'
- description: The branding information for iOS devices.
DeviceTypeLinux:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information for Linux devices.
DeviceTypeWeb:
allOf:
- $ref: '#/components/schemas/DefaultClientBrandingAttributes'
- description: The branding information for Web access.
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.
DescribeClientPropertiesResult:
type: object
properties:
ClientPropertiesList:
allOf:
- $ref: '#/components/schemas/ClientPropertiesList'
- description: Information about the specified Amazon WorkSpaces clients.
DescribeClientPropertiesRequest:
type: object
required:
- ResourceIds
title: DescribeClientPropertiesRequest
properties:
ResourceIds:
allOf:
- $ref: '#/components/schemas/ResourceIdList'
- description: 'The resource identifier, in the form of directory IDs.'
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. '
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.
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. '
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 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 results to return.
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. '
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 a NextToken from a previous call that was paginated, provide this token to receive the next set of results. '
DescribeIpGroupsResult:
type: object
properties:
Result:
allOf:
- $ref: '#/components/schemas/WorkspacesIpGroupsList'
- description: Information about the IP access control groups.
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. '
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.
DescribeTagsResult:
type: object
properties:
TagList:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags.
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.'
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.
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.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.'
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. '
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.
DescribeWorkspaceImagesResult:
type: object
properties:
Images:
allOf:
- $ref: '#/components/schemas/WorkspaceImageList'
- description: Information about the images.
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. '
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.
DescribeWorkspaceSnapshotsResult:
type: object
properties:
RebuildSnapshots:
allOf:
- $ref: '#/components/schemas/SnapshotList'
- description: Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.
RestoreSnapshots:
allOf:
- $ref: '#/components/schemas/SnapshotList'
- description: Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.
DescribeWorkspaceSnapshotsRequest:
type: object
required:
- WorkspaceId
title: DescribeWorkspaceSnapshotsRequest
properties:
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace.
DescribeWorkspacesResult:
type: object
properties:
Workspaces:
allOf:
- $ref: '#/components/schemas/WorkspaceList'
- description: '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. ' DescribeWorkspacesRequest: type: object title: DescribeWorkspacesRequest properties: WorkspaceIds: allOf: - $ref: '#/components/schemas/WorkspaceIdList' - description: '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.'
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. '
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.'
DisassociateConnectionAliasResult:
type: object
properties: {}
DisassociateConnectionAliasRequest:
type: object
required:
- AliasId
title: DisassociateConnectionAliasRequest
properties:
AliasId:
allOf:
- $ref: '#/components/schemas/ConnectionAliasId'
- description: The identifier of the connection alias to disassociate.
DisassociateIpGroupsResult:
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.
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.
ImportWorkspaceImageResult:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/WorkspaceImageId'
- description: The identifier of the WorkSpace image.
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.
NextToken from a previous call that was paginated, provide this token to receive the next set of results.'
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.'
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.
OperationInProgressException: {}
ModifyAccountResult:
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.'
ModifyCertificateBasedAuthPropertiesResult:
type: object
properties: {}
ModifyCertificateBasedAuthPropertiesRequest:
type: object
required:
- ResourceId
title: ModifyCertificateBasedAuthPropertiesRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: 'The resource identifiers, in the form of directory IDs.'
CertificateBasedAuthProperties:
allOf:
- $ref: '#/components/schemas/CertificateBasedAuthProperties'
- description: The properties of the certificate-based authentication.
PropertiesToDelete:
allOf:
- $ref: '#/components/schemas/DeletableCertificateBasedAuthPropertiesList'
- description: The properties of the certificate-based authentication you want to delete.
ModifyClientPropertiesResult:
type: object
properties: {}
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.
ModifySamlPropertiesResult:
type: object
properties: {}
ModifySamlPropertiesRequest:
type: object
required:
- ResourceId
title: ModifySamlPropertiesRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier for which you want to configure SAML properties.
SamlProperties:
allOf:
- $ref: '#/components/schemas/SamlProperties'
- description: The properties for configuring SAML 2.0 authentication.
PropertiesToDelete:
allOf:
- $ref: '#/components/schemas/DeletableSamlPropertiesList'
- description: '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.
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.
WorkspacesDefaultRoleNotFoundException: {}
UnsupportedNetworkConfigurationException: {}
RestoreWorkspaceResult:
type: object
properties: {}
RestoreWorkspaceRequest:
type: object
required:
- WorkspaceId
title: RestoreWorkspaceRequest
properties:
WorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the WorkSpace.
RevokeIpRulesResult:
type: object
properties: {}
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.
StartWorkspacesResult:
type: object
properties:
FailedRequests:
allOf:
- $ref: '#/components/schemas/FailedStartWorkspaceRequests'
- description: Information about the WorkSpaces that could not be started.
StartWorkspacesRequest:
type: object
required:
- StartWorkspaceRequests
title: StartWorkspacesRequest
properties:
StartWorkspaceRequests:
allOf:
- $ref: '#/components/schemas/StartWorkspaceRequests'
- description: The WorkSpaces to start. You can specify up to 25 WorkSpaces.
StopWorkspacesResult:
type: object
properties:
FailedRequests:
allOf:
- $ref: '#/components/schemas/FailedStopWorkspaceRequests'
- description: Information about the WorkSpaces that could not be stopped.
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.
TerminateWorkspacesResult:
type: object
properties:
FailedRequests:
allOf:
- $ref: '#/components/schemas/FailedTerminateWorkspaceRequests'
- description: Information about the WorkSpaces that could not be terminated.
TerminateWorkspacesRequest:
type: object
required:
- TerminateWorkspaceRequests
title: TerminateWorkspacesRequest
properties:
TerminateWorkspaceRequests:
allOf:
- $ref: '#/components/schemas/TerminateWorkspaceRequests'
- description: The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
UpdateConnectClientAddInResult:
type: object
properties: {}
UpdateConnectClientAddInRequest:
type: object
required:
- AddInId
- ResourceId
title: UpdateConnectClientAddInRequest
properties:
AddInId:
allOf:
- $ref: '#/components/schemas/AmazonUuid'
- description: The identifier of the client add-in to update.
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier for which the client add-in is configured.
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.
UpdateConnectionAliasPermissionResult:
type: object
properties: {}
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.
UpdateRulesOfIpGroupResult:
type: object
properties: {}
UpdateRulesOfIpGroupRequest:
type: object
required:
- GroupId
- UserRules
title: UpdateRulesOfIpGroupRequest
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/IpGroupId'
- description: The identifier of the group.
UserRules:
allOf:
- $ref: '#/components/schemas/IpRuleList'
- description: One or more rules.
UpdateWorkspaceBundleResult:
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.
UpdateWorkspaceImagePermissionResult:
type: object
properties: {}
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.
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.
BundleList:
type: array
items:
$ref: '#/components/schemas/WorkspaceBundle'
BundleOwner:
type: string
BundleType:
type: string
enum:
- REGULAR
- STANDBY
CertificateAuthorityArn:
type: string
pattern: 'arn:[\w+=/,.@-]+:[\w+=/,.@-]+:[\w+=/,.@-]*:[0-9]*:[\w+=,.@-]+(/[\w+=,.@-]+)*'
minLength: 5
maxLength: 200
CertificateBasedAuthStatusEnum:
type: string
enum:
- DISABLED
- ENABLED
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.
ClientDeviceType:
type: string
enum:
- DeviceTypeWindows
- DeviceTypeOsx
- DeviceTypeAndroid
- DeviceTypeIos
- DeviceTypeLinux
- DeviceTypeWeb
ClientDeviceTypeList:
type: array
items:
$ref: '#/components/schemas/ClientDeviceType'
minItems: 1
maxItems: 6
ClientEmail:
type: string
pattern: '^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,4}$'
minLength: 6
maxLength: 64
ClientLocale:
type: string
pattern: '^[a-z]{2}_[A-Z]{2}$'
minLength: 5
maxLength: 5
ClientLoginMessage:
type: string
pattern: ^.*$
minLength: 0
maxLength: 2000
ReconnectEnum:
type: string
enum:
- ENABLED
- DISABLED
LogUploadEnum:
type: string
enum:
- ENABLED
- DISABLED
ClientProperties:
type: object
properties:
ReconnectEnabled:
allOf:
- $ref: '#/components/schemas/ReconnectEnum'
- description: 'Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials. '
LogUploadEnabled:
allOf:
- $ref: '#/components/schemas/LogUploadEnum'
- description: 'Specifies whether users can upload diagnostic log files of Amazon WorkSpaces client directly to WorkSpaces to troubleshoot issues when using the WorkSpaces client. When enabled,
the log files will be sent to WorkSpaces automatically and will be applied to all users in the specified directory.'
description: Describes an Amazon WorkSpaces client.
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.
ClientPropertiesList:
type: array
items:
$ref: '#/components/schemas/ClientPropertiesResult'
ClientUrl:
type: string
pattern: '^(http|https)\://\S+'
minLength: 1
maxLength: 200
Compute:
type: string
enum:
- VALUE
- STANDARD
- PERFORMANCE
- POWER
- GRAPHICS
- POWERPRO
- GRAPHICSPRO
- GRAPHICS_G4DN
- GRAPHICSPRO_G4DN
ComputeType:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/Compute'
- description: The compute type.
description: Describes the compute type of the bundle.
ComputerName:
type: string
ConnectClientAddIn:
type: object
properties:
AddInId:
allOf:
- $ref: '#/components/schemas/AmazonUuid'
- description: The client add-in identifier.
ResourceId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The directory identifier for which the client add-in is configured.
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 client add-in.
description: Describes an Amazon Connect client add-in.
ConnectClientAddInList:
type: array
items:
$ref: '#/components/schemas/ConnectClientAddIn'
ConnectionString:
type: string
pattern: '^[.0-9a-zA-Z\-]{1,255}$'
minLength: 1
maxLength: 255
ConnectionAliasState:
type: string
enum:
- CREATING
- CREATED
- DELETING
ConnectionAliasAssociationList:
type: array
items:
$ref: '#/components/schemas/ConnectionAliasAssociation'
minItems: 1
maxItems: 25
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.'
ConnectionAliasAssociation:
type: object
properties:
AssociationStatus:
allOf:
- $ref: '#/components/schemas/AssociationStatus'
- description: The association status of the connection alias.
AssociatedAccountId:
allOf:
- $ref: '#/components/schemas/AwsAccount'
- description: The identifier of the Amazon Web Services account that associated the connection alias with a directory.
ResourceId:
allOf:
- $ref: '#/components/schemas/NonEmptyString'
- description: The identifier of the directory associated with a connection alias.
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.
description: 'Describes a connection alias association that is used for cross-Region redirection. For more information, see
Cross-Region Redirection for Amazon WorkSpaces.'
ConnectionAliasIdList:
type: array
items:
$ref: '#/components/schemas/ConnectionAliasId'
minItems: 1
maxItems: 25
ConnectionAliasList:
type: array
items:
$ref: '#/components/schemas/ConnectionAlias'
minItems: 1
maxItems: 25
ConnectionAliasPermission:
type: object
required:
- SharedAccountId
- AllowAssociation
properties:
SharedAccountId:
allOf:
- $ref: '#/components/schemas/AwsAccount'
- description: The identifier of the Amazon Web Services account that the connection alias is shared with.
AllowAssociation:
allOf:
- $ref: '#/components/schemas/BooleanObject'
- description: Indicates whether the specified Amazon Web Services account is allowed to associate the connection alias with a directory.
description: 'Describes the permissions for a connection alias. Connection aliases are used for cross-Region redirection. For more information, see
Cross-Region Redirection for Amazon WorkSpaces.'
ConnectionAliasPermissions:
type: array
items:
$ref: '#/components/schemas/ConnectionAliasPermission'
minItems: 1
maxItems: 25
ConnectionState:
type: string
enum:
- CONNECTED
- DISCONNECTED
- UNKNOWN
WorkspaceImageName:
type: string
pattern: '^[a-zA-Z0-9_./()\\-]+$'
minLength: 1
maxLength: 64
WorkspaceImageDescription:
type: string
pattern: '^[a-zA-Z0-9_./() -]+$'
minLength: 1
maxLength: 256
WorkspaceImageId:
type: string
pattern: 'wsi-[0-9a-z]{9,63}$'
Region:
type: string
pattern: '^[-0-9a-z]{1,31}$'
minLength: 1
maxLength: 31
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
IpGroupName:
type: string
IpGroupDesc:
type: string
StandbyWorkspacesList:
type: array
items:
$ref: '#/components/schemas/StandbyWorkspace'
FailedCreateStandbyWorkspacesRequestList:
type: array
items:
$ref: '#/components/schemas/FailedCreateStandbyWorkspacesRequest'
PendingCreateStandbyWorkspacesRequestList:
type: array
items:
$ref: '#/components/schemas/PendingCreateStandbyWorkspacesRequest'
WorkspaceBundleName:
type: string
pattern: '^[a-zA-Z0-9_./()\\-]+$'
minLength: 1
maxLength: 64
WorkspaceBundleDescription:
type: string
pattern: '^[a-zA-Z0-9_./() -]+$'
minLength: 1
maxLength: 255
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.
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.
WorkspaceId:
type: string
pattern: '^ws-[0-9a-z]{8,63}$'
OperatingSystem:
type: object
properties:
Type:
allOf:
- $ref: '#/components/schemas/OperatingSystemType'
- description: The operating system.
description: The operating system that the image is running.
WorkspaceImageState:
type: string
enum:
- AVAILABLE
- PENDING
- ERROR
WorkspaceImageRequiredTenancy:
type: string
enum:
- DEFAULT
- DEDICATED
WorkspaceRequestList:
type: array
items:
$ref: '#/components/schemas/WorkspaceRequest'
minItems: 1
maxItems: 25
FailedCreateWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedCreateWorkspaceRequest'
WorkspaceList:
type: array
items:
$ref: '#/components/schemas/Workspace'
DedicatedTenancyCidrRangeList:
type: array
items:
$ref: '#/components/schemas/DedicatedTenancyManagementCidrRange'
DedicatedTenancySupportEnum:
type: string
enum:
- ENABLED
LoginMessage:
type: object
additionalProperties:
$ref: '#/components/schemas/ClientLoginMessage'
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.
.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.
.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.
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.
DirectoryName:
type: string
IpAddress:
type: string
DnsIpAddresses:
type: array
items:
$ref: '#/components/schemas/IpAddress'
Ec2ImageId:
type: string
pattern: '^ami\-([a-f0-9]{8}|[a-f0-9]{17})$'
ErrorType:
type: string
StandbyWorkspace:
type: object
required:
- PrimaryWorkspaceId
- DirectoryId
properties:
PrimaryWorkspaceId:
allOf:
- $ref: '#/components/schemas/WorkspaceId'
- description: The identifier of the standby WorkSpace.
VolumeEncryptionKey:
allOf:
- $ref: '#/components/schemas/VolumeEncryptionKey'
- description: The volume encryption key of the standby WorkSpace.
DirectoryId:
allOf:
- $ref: '#/components/schemas/DirectoryId'
- description: The identifier of the directory for the standby WorkSpace.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags associated with the standby WorkSpace.
description: Describes a standby WorkSpace.
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.
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.
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.
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).'
FailedRebootWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
FailedRebuildWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
FailedStartWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
FailedStopWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
FailedTerminateWorkspaceRequests:
type: array
items:
$ref: '#/components/schemas/FailedWorkspaceChangeRequest'
ImagePermission:
type: object
properties:
SharedAccountId:
allOf:
- $ref: '#/components/schemas/AwsAccount'
- description: The identifier of the Amazon Web Services account that an image has been shared with.
description: 'Describes the Amazon Web Services accounts that have been granted permission to use a shared image. For more information about sharing images, see
Share or Unshare a Custom WorkSpaces 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.
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.' SelfservicePermissions: type: object properties: RestartWorkspace: allOf: - $ref: '#/components/schemas/ReconnectEnum' - description: Specifies whether users can restart their WorkSpace. IncreaseVolumeSize: allOf: - $ref: '#/components/schemas/ReconnectEnum' - description: Specifies whether users can increase the volume size of the drives on their WorkSpace. ChangeComputeType: allOf: - $ref: '#/components/schemas/ReconnectEnum' - description: Specifies whether users can change the compute type (bundle) for their WorkSpace. SwitchRunningMode: allOf: - $ref: '#/components/schemas/ReconnectEnum' - description: Specifies whether users can switch the running mode of their WorkSpace. RebuildWorkspace: allOf: - $ref: '#/components/schemas/ReconnectEnum' - description: Specifies whether users can rebuild the operating system of a WorkSpace to its original state. description: 'Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.' 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.' WorkspaceCreationProperties: type: object properties: EnableWorkDocs: allOf: - $ref: '#/components/schemas/BooleanObject' - description: '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 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. Protocol: type: string enum: - PCOIP - WSP ProtocolList: type: array items: $ref: '#/components/schemas/Protocol' 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. RebootWorkspaceRequests: type: array items: $ref: '#/components/schemas/RebootRequest' minItems: 1 maxItems: 25 RebuildRequest: type: object required: - WorkspaceId properties: WorkspaceId: allOf: - $ref: '#/components/schemas/WorkspaceId' - description: The identifier of the WorkSpace. description: Describes the information used to rebuild a WorkSpace. RebuildWorkspaceRequests: type: array items: $ref: '#/components/schemas/RebuildRequest' minItems: 1 maxItems: 1 SubnetIds: type: array items: $ref: '#/components/schemas/SubnetId' maxItems: 2 Tenancy: type: string enum: - DEDICATED - SHARED RegistrationCode: type: string minLength: 1 maxLength: 20 StandbyWorkspaceRelationshipType: type: string enum: - PRIMARY - STANDBY 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. RelatedWorkspaces: type: array items: $ref: '#/components/schemas/RelatedWorkspaceProperties' RootVolumeSizeGib: type: integer RunningMode: type: string enum: - AUTO_STOP - ALWAYS_ON - MANUAL RunningModeAutoStopTimeoutInMinutes: type: integer SamlStatusEnum: type: string enum: - DISABLED - ENABLED - ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK SamlUserAccessUrl: type: string pattern: '^(http|https)\://\S+$' minLength: 8 maxLength: 200 Snapshot: type: object properties: SnapshotTime: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the snapshot was created. description: Describes a snapshot. VolumeEncryptionKey: type: string StartRequest: type: object properties: WorkspaceId: allOf: - $ref: '#/components/schemas/WorkspaceId' - description: The identifier of the WorkSpace. description: Information used to start a WorkSpace. StartWorkspaceRequests: type: array items: $ref: '#/components/schemas/StartRequest' minItems: 1 maxItems: 25 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. StopWorkspaceRequests: type: array items: $ref: '#/components/schemas/StopRequest' minItems: 1 maxItems: 25 SubnetId: type: string pattern: '^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$' minLength: 15 maxLength: 24 TagKey: type: string minLength: 1 maxLength: 127 TagValue: type: string maxLength: 255 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. TerminateRequest: type: object required: - WorkspaceId properties: WorkspaceId: allOf: - $ref: '#/components/schemas/WorkspaceId' - description: The identifier of the WorkSpace. description: Describes the information used to terminate a WorkSpace. TerminateWorkspaceRequests: type: array items: $ref: '#/components/schemas/TerminateRequest' minItems: 1 maxItems: 25 UpdateDescription: type: string pattern: '^[a-zA-Z0-9_./() -]+$' minLength: 1 maxLength: 255 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.
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.
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.
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.
security:
- hmac: []