# Actions The following actions are supported: + [AcceptAccountLinkInvitation](API_AcceptAccountLinkInvitation.md) + [AssociateConnectionAlias](API_AssociateConnectionAlias.md) + [AssociateIpGroups](API_AssociateIpGroups.md) + [AssociateWorkspaceApplication](API_AssociateWorkspaceApplication.md) + [AuthorizeIpRules](API_AuthorizeIpRules.md) + [CopyWorkspaceImage](API_CopyWorkspaceImage.md) + [CreateAccountLinkInvitation](API_CreateAccountLinkInvitation.md) + [CreateConnectClientAddIn](API_CreateConnectClientAddIn.md) + [CreateConnectionAlias](API_CreateConnectionAlias.md) + [CreateIpGroup](API_CreateIpGroup.md) + [CreateStandbyWorkspaces](API_CreateStandbyWorkspaces.md) + [CreateTags](API_CreateTags.md) + [CreateUpdatedWorkspaceImage](API_CreateUpdatedWorkspaceImage.md) + [CreateWorkspaceBundle](API_CreateWorkspaceBundle.md) + [CreateWorkspaceImage](API_CreateWorkspaceImage.md) + [CreateWorkspaces](API_CreateWorkspaces.md) + [CreateWorkspacesPool](API_CreateWorkspacesPool.md) + [DeleteAccountLinkInvitation](API_DeleteAccountLinkInvitation.md) + [DeleteClientBranding](API_DeleteClientBranding.md) + [DeleteConnectClientAddIn](API_DeleteConnectClientAddIn.md) + [DeleteConnectionAlias](API_DeleteConnectionAlias.md) + [DeleteIpGroup](API_DeleteIpGroup.md) + [DeleteTags](API_DeleteTags.md) + [DeleteWorkspaceBundle](API_DeleteWorkspaceBundle.md) + [DeleteWorkspaceImage](API_DeleteWorkspaceImage.md) + [DeployWorkspaceApplications](API_DeployWorkspaceApplications.md) + [DeregisterWorkspaceDirectory](API_DeregisterWorkspaceDirectory.md) + [DescribeAccount](API_DescribeAccount.md) + [DescribeAccountModifications](API_DescribeAccountModifications.md) + [DescribeApplicationAssociations](API_DescribeApplicationAssociations.md) + [DescribeApplications](API_DescribeApplications.md) + [DescribeBundleAssociations](API_DescribeBundleAssociations.md) + [DescribeClientBranding](API_DescribeClientBranding.md) + [DescribeClientProperties](API_DescribeClientProperties.md) + [DescribeConnectClientAddIns](API_DescribeConnectClientAddIns.md) + [DescribeConnectionAliases](API_DescribeConnectionAliases.md) + [DescribeConnectionAliasPermissions](API_DescribeConnectionAliasPermissions.md) + [DescribeCustomWorkspaceImageImport](API_DescribeCustomWorkspaceImageImport.md) + [DescribeImageAssociations](API_DescribeImageAssociations.md) + [DescribeIpGroups](API_DescribeIpGroups.md) + [DescribeTags](API_DescribeTags.md) + [DescribeWorkspaceAssociations](API_DescribeWorkspaceAssociations.md) + [DescribeWorkspaceBundles](API_DescribeWorkspaceBundles.md) + [DescribeWorkspaceDirectories](API_DescribeWorkspaceDirectories.md) + [DescribeWorkspaceImagePermissions](API_DescribeWorkspaceImagePermissions.md) + [DescribeWorkspaceImages](API_DescribeWorkspaceImages.md) + [DescribeWorkspaces](API_DescribeWorkspaces.md) + [DescribeWorkspacesConnectionStatus](API_DescribeWorkspacesConnectionStatus.md) + [DescribeWorkspaceSnapshots](API_DescribeWorkspaceSnapshots.md) + [DescribeWorkspacesPools](API_DescribeWorkspacesPools.md) + [DescribeWorkspacesPoolSessions](API_DescribeWorkspacesPoolSessions.md) + [DisassociateConnectionAlias](API_DisassociateConnectionAlias.md) + [DisassociateIpGroups](API_DisassociateIpGroups.md) + [DisassociateWorkspaceApplication](API_DisassociateWorkspaceApplication.md) + [GetAccountLink](API_GetAccountLink.md) + [ImportClientBranding](API_ImportClientBranding.md) + [ImportCustomWorkspaceImage](API_ImportCustomWorkspaceImage.md) + [ImportWorkspaceImage](API_ImportWorkspaceImage.md) + [ListAccountLinks](API_ListAccountLinks.md) + [ListAvailableManagementCidrRanges](API_ListAvailableManagementCidrRanges.md) + [MigrateWorkspace](API_MigrateWorkspace.md) + [ModifyAccount](API_ModifyAccount.md) + [ModifyCertificateBasedAuthProperties](API_ModifyCertificateBasedAuthProperties.md) + [ModifyClientProperties](API_ModifyClientProperties.md) + [ModifyEndpointEncryptionMode](API_ModifyEndpointEncryptionMode.md) + [ModifySamlProperties](API_ModifySamlProperties.md) + [ModifySelfservicePermissions](API_ModifySelfservicePermissions.md) + [ModifyStreamingProperties](API_ModifyStreamingProperties.md) + [ModifyWorkspaceAccessProperties](API_ModifyWorkspaceAccessProperties.md) + [ModifyWorkspaceCreationProperties](API_ModifyWorkspaceCreationProperties.md) + [ModifyWorkspaceProperties](API_ModifyWorkspaceProperties.md) + [ModifyWorkspaceState](API_ModifyWorkspaceState.md) + [RebootWorkspaces](API_RebootWorkspaces.md) + [RebuildWorkspaces](API_RebuildWorkspaces.md) + [RegisterWorkspaceDirectory](API_RegisterWorkspaceDirectory.md) + [RejectAccountLinkInvitation](API_RejectAccountLinkInvitation.md) + [RestoreWorkspace](API_RestoreWorkspace.md) + [RevokeIpRules](API_RevokeIpRules.md) + [StartWorkspaces](API_StartWorkspaces.md) + [StartWorkspacesPool](API_StartWorkspacesPool.md) + [StopWorkspaces](API_StopWorkspaces.md) + [StopWorkspacesPool](API_StopWorkspacesPool.md) + [TerminateWorkspaces](API_TerminateWorkspaces.md) + [TerminateWorkspacesPool](API_TerminateWorkspacesPool.md) + [TerminateWorkspacesPoolSession](API_TerminateWorkspacesPoolSession.md) + [UpdateConnectClientAddIn](API_UpdateConnectClientAddIn.md) + [UpdateConnectionAliasPermission](API_UpdateConnectionAliasPermission.md) + [UpdateRulesOfIpGroup](API_UpdateRulesOfIpGroup.md) + [UpdateWorkspaceBundle](API_UpdateWorkspaceBundle.md) + [UpdateWorkspaceImagePermission](API_UpdateWorkspaceImagePermission.md) + [UpdateWorkspacesPool](API_UpdateWorkspacesPool.md) # AcceptAccountLinkInvitation Accepts the account link invitation. **Important** There's currently no unlinking capability after you accept the account linking invitation. ## Request Syntax ``` { "ClientToken": "string", "LinkId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ClientToken](#API_AcceptAccountLinkInvitation_RequestSyntax) ** A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation. Type: String Pattern: `^.{1,64}$` Required: No ** [LinkId](#API_AcceptAccountLinkInvitation_RequestSyntax) ** The identifier of the account link. Type: String Pattern: `^link-.{8,24}$` Required: Yes ## Response Syntax ``` { "AccountLink": { "AccountLinkId": "string", "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AccountLink](#API_AcceptAccountLinkInvitation_ResponseSyntax) ** Information about the account link. Type: [AccountLink](API_AccountLink.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** ConflictException ** The `TargetAccountId` is already linked or invited. HTTP Status Code: 400 ** InternalServerException ** Unexpected server error occured. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ValidationException ** You either haven't provided a `TargetAccountId` or are using the same value for `TargetAccountId` and `SourceAccountId`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/AcceptAccountLinkInvitation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/AcceptAccountLinkInvitation) # AssociateConnectionAlias Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). **Note** Before performing this operation, call [ DescribeConnectionAliases](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) to make sure that the current state of the connection alias is `CREATED`. ## Request Syntax ``` { "AliasId": "string", "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AliasId](#API_AssociateConnectionAlias_RequestSyntax) ** The identifier of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: `^wsca-[0-9a-z]{8,63}$` Required: Yes ** [ResourceId](#API_AssociateConnectionAlias_RequestSyntax) ** The identifier of the directory to associate the connection alias with. Type: String Length Constraints: Minimum length of 1. Required: Yes ## Response Syntax ``` { "ConnectionIdentifier": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ConnectionIdentifier](#API_AssociateConnectionAlias_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: `^[a-zA-Z0-9]+$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAssociatedException ** The resource is associated with a directory. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/AssociateConnectionAlias) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/AssociateConnectionAlias) # AssociateIpGroups Associates the specified IP access control group with the specified directory. ## Request Syntax ``` { "DirectoryId": "string", "GroupIds": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DirectoryId](#API_AssociateIpGroups_RequestSyntax) ** The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [GroupIds](#API_AssociateIpGroups_RequestSyntax) ** The identifiers of one or more IP access control groups. Type: Array of strings Pattern: `wsipg-[0-9a-z]{8,63}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/AssociateIpGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/AssociateIpGroups) # AssociateWorkspaceApplication Associates the specified application to the specified WorkSpace. ## Request Syntax ``` { "ApplicationId": "string", "WorkspaceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationId](#API_AssociateWorkspaceApplication_RequestSyntax) ** The identifier of the application. Type: String Pattern: `^wsa-[0-9a-z]{8,63}$` Required: Yes ** [WorkspaceId](#API_AssociateWorkspaceApplication_RequestSyntax) ** The identifier of the WorkSpace. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ## Response Syntax ``` { "Association": { "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "string" }, "WorkspaceId": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Association](#API_AssociateWorkspaceApplication_ResponseSyntax) ** Information about the association between the specified WorkSpace and the specified application. Type: [WorkspaceResourceAssociation](API_WorkspaceResourceAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** ApplicationNotSupportedException ** The specified application is not supported. HTTP Status Code: 400 ** ComputeNotCompatibleException ** The compute type of the WorkSpace is not compatible with the application. HTTP Status Code: 400 ** IncompatibleApplicationsException ** The specified application is not compatible with the resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperatingSystemNotCompatibleException ** The operating system of the WorkSpace is not compatible with the application. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is currently in use. ** ResourceId ** The ID of the resource that is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/AssociateWorkspaceApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/AssociateWorkspaceApplication) # AuthorizeIpRules 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. ## Request Syntax ``` { "GroupId": "string", "UserRules": [ { "ipRule": "string", "ruleDesc": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [GroupId](#API_AuthorizeIpRules_RequestSyntax) ** The identifier of the group. Type: String Pattern: `wsipg-[0-9a-z]{8,63}$` Required: Yes ** [UserRules](#API_AuthorizeIpRules_RequestSyntax) ** The rules to add to the group. Type: Array of [IpRuleItem](API_IpRuleItem.md) objects Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/AuthorizeIpRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/AuthorizeIpRules) # CopyWorkspaceImage Copies the specified image from the specified Region to the current Region. For more information about copying images, see [ Copy a Custom WorkSpaces Image](https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html). In the China (Ningxia) Region, you can copy images only within the same Region. In AWS GovCloud (US), to copy images to and from other Regions, contact Support. **Important** Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the ID of the AWS account that owns an image, use the [DescribeWorkSpaceImages](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html) and [DescribeWorkspaceImagePermissions](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html) API operations. ## Request Syntax ``` { "Description": "string", "Name": "string", "SourceImageId": "string", "SourceRegion": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Description](#API_CopyWorkspaceImage_RequestSyntax) ** A description of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9_./() -]+$` Required: No ** [Name](#API_CopyWorkspaceImage_RequestSyntax) ** The name of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_./()\\-]+$` Required: Yes ** [SourceImageId](#API_CopyWorkspaceImage_RequestSyntax) ** The identifier of the source image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: Yes ** [SourceRegion](#API_CopyWorkspaceImage_RequestSyntax) ** The identifier of the source Region. Type: String Length Constraints: Minimum length of 1. Maximum length of 31. Pattern: `^[-0-9a-z]{1,31}$` Required: Yes ** [Tags](#API_CopyWorkspaceImage_RequestSyntax) ** The tags for the image. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` { "ImageId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageId](#API_CopyWorkspaceImage_ResponseSyntax) ** The identifier of the image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ResourceUnavailableException ** The specified resource is not available. ** message ** The exception error message. ** ResourceId ** The identifier of the resource that is not available. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CopyWorkspaceImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CopyWorkspaceImage) # CreateAccountLinkInvitation Creates the account link invitation. ## Request Syntax ``` { "ClientToken": "string", "TargetAccountId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ClientToken](#API_CreateAccountLinkInvitation_RequestSyntax) ** A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation. Type: String Pattern: `^.{1,64}$` Required: No ** [TargetAccountId](#API_CreateAccountLinkInvitation_RequestSyntax) ** The identifier of the target account. Type: String Pattern: `^\d{12}$` Required: Yes ## Response Syntax ``` { "AccountLink": { "AccountLinkId": "string", "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AccountLink](#API_CreateAccountLinkInvitation_ResponseSyntax) ** Information about the account link. Type: [AccountLink](API_AccountLink.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** ConflictException ** The `TargetAccountId` is already linked or invited. HTTP Status Code: 400 ** InternalServerException ** Unexpected server error occured. HTTP Status Code: 400 ** ValidationException ** You either haven't provided a `TargetAccountId` or are using the same value for `TargetAccountId` and `SourceAccountId`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateAccountLinkInvitation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateAccountLinkInvitation) # CreateConnectClientAddIn 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. ## Request Syntax ``` { "Name": "string", "ResourceId": "string", "URL": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Name](#API_CreateConnectClientAddIn_RequestSyntax) ** The name of the client add-in. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^.*$` Required: Yes ** [ResourceId](#API_CreateConnectClientAddIn_RequestSyntax) ** The directory identifier for which to configure the client add-in. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [URL](#API_CreateConnectClientAddIn_RequestSyntax) ** The endpoint URL of the Amazon Connect client add-in. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `^(http|https)\://\S+` Required: Yes ## Response Syntax ``` { "AddInId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AddInId](#API_CreateConnectClientAddIn_ResponseSyntax) ** The client add-in identifier. Type: String Length Constraints: Fixed length of 36. Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceCreationFailedException ** The resource could not be created. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateConnectClientAddIn) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateConnectClientAddIn) # CreateConnectionAlias Creates the specified connection alias for use with cross-Region redirection. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). ## Request Syntax ``` { "ConnectionString": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ConnectionString](#API_CreateConnectionAlias_RequestSyntax) ** 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 AWS 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[.0-9a-zA-Z\-]{1,255}$` Required: Yes ** [Tags](#API_CreateConnectionAlias_RequestSyntax) ** The tags to associate with the connection alias. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` { "AliasId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AliasId](#API_CreateConnectionAlias_ResponseSyntax) ** The identifier of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: `^wsca-[0-9a-z]{8,63}$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateConnectionAlias) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateConnectionAlias) # CreateIpGroup 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](API_AuthorizeIpRules.md). 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. ## Request Syntax ``` { "GroupDesc": "string", "GroupName": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "UserRules": [ { "ipRule": "string", "ruleDesc": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [GroupDesc](#API_CreateIpGroup_RequestSyntax) ** The description of the group. Type: String Required: No ** [GroupName](#API_CreateIpGroup_RequestSyntax) ** The name of the group. Type: String Required: Yes ** [Tags](#API_CreateIpGroup_RequestSyntax) ** The tags. Each WorkSpaces resource can have a maximum of 50 tags. Type: Array of [Tag](API_Tag.md) objects Required: No ** [UserRules](#API_CreateIpGroup_RequestSyntax) ** The rules to add to the group. Type: Array of [IpRuleItem](API_IpRuleItem.md) objects Required: No ## Response Syntax ``` { "GroupId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [GroupId](#API_CreateIpGroup_ResponseSyntax) ** The identifier of the group. Type: String Pattern: `wsipg-[0-9a-z]{8,63}$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceCreationFailedException ** The resource could not be created. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateIpGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateIpGroup) # CreateStandbyWorkspaces Creates a standby WorkSpace in a secondary Region. ## Request Syntax ``` { "PrimaryRegion": "string", "StandbyWorkspaces": [ { "DataReplication": "string", "DirectoryId": "string", "PrimaryWorkspaceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeEncryptionKey": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PrimaryRegion](#API_CreateStandbyWorkspaces_RequestSyntax) ** The Region of the primary WorkSpace. Type: String Length Constraints: Minimum length of 1. Maximum length of 31. Pattern: `^[-0-9a-z]{1,31}$` Required: Yes ** [StandbyWorkspaces](#API_CreateStandbyWorkspaces_RequestSyntax) ** Information about the standby WorkSpace to be created. Type: Array of [StandbyWorkspace](API_StandbyWorkspace.md) objects Required: Yes ## Response Syntax ``` { "FailedStandbyRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "StandbyWorkspaceRequest": { "DataReplication": "string", "DirectoryId": "string", "PrimaryWorkspaceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "VolumeEncryptionKey": "string" } } ], "PendingStandbyRequests": [ { "DirectoryId": "string", "State": "string", "UserName": "string", "WorkspaceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FailedStandbyRequests](#API_CreateStandbyWorkspaces_ResponseSyntax) ** Information about the standby WorkSpace that could not be created. Type: Array of [FailedCreateStandbyWorkspacesRequest](API_FailedCreateStandbyWorkspacesRequest.md) objects ** [PendingStandbyRequests](#API_CreateStandbyWorkspaces_ResponseSyntax) ** Information about the standby WorkSpace that was created. Type: Array of [PendingCreateStandbyWorkspacesRequest](API_PendingCreateStandbyWorkspacesRequest.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateStandbyWorkspaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateStandbyWorkspaces) # CreateTags Creates the specified tags for the specified WorkSpaces resource. ## Request Syntax ``` { "ResourceId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceId](#API_CreateTags_RequestSyntax) ** The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases. Type: String Length Constraints: Minimum length of 1. Required: Yes ** [Tags](#API_CreateTags_RequestSyntax) ** The tags. Each WorkSpaces resource can have a maximum of 50 tags. Type: Array of [Tag](API_Tag.md) objects Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateTags) # CreateUpdatedWorkspaceImage 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](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html). **Note** 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. ## Request Syntax ``` { "Description": "string", "Name": "string", "SourceImageId": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Description](#API_CreateUpdatedWorkspaceImage_RequestSyntax) ** A description of whether updates for the WorkSpace image are available. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9_./() -]+$` Required: Yes ** [Name](#API_CreateUpdatedWorkspaceImage_RequestSyntax) ** The name of the new updated WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_./()\\-]+$` Required: Yes ** [SourceImageId](#API_CreateUpdatedWorkspaceImage_RequestSyntax) ** The identifier of the source WorkSpace image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: Yes ** [Tags](#API_CreateUpdatedWorkspaceImage_RequestSyntax) ** 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`. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` { "ImageId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageId](#API_CreateUpdatedWorkspaceImage_ResponseSyntax) ** The identifier of the new updated WorkSpace image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateUpdatedWorkspaceImage) # CreateWorkspaceBundle Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see [ Create a Custom WorkSpaces Image and Bundle](https://docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html). ## Request Syntax ``` { "BundleDescription": "string", "BundleName": "string", "ComputeType": { "Name": "string" }, "ImageId": "string", "RootStorage": { "Capacity": "string" }, "Tags": [ { "Key": "string", "Value": "string" } ], "UserStorage": { "Capacity": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [BundleDescription](#API_CreateWorkspaceBundle_RequestSyntax) ** The description of the bundle. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z0-9_./() -]+$` Required: Yes ** [BundleName](#API_CreateWorkspaceBundle_RequestSyntax) ** The name of the bundle. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_./()\\-]+$` Required: Yes ** [ComputeType](#API_CreateWorkspaceBundle_RequestSyntax) ** Describes the compute type of the bundle. Type: [ComputeType](API_ComputeType.md) object Required: Yes ** [ImageId](#API_CreateWorkspaceBundle_RequestSyntax) ** The identifier of the image that is used to create the bundle. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: Yes ** [RootStorage](#API_CreateWorkspaceBundle_RequestSyntax) ** Describes the root volume for a WorkSpace bundle. Type: [RootStorage](API_RootStorage.md) object Required: No ** [Tags](#API_CreateWorkspaceBundle_RequestSyntax) ** 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`. Type: Array of [Tag](API_Tag.md) objects Required: No ** [UserStorage](#API_CreateWorkspaceBundle_RequestSyntax) ** Describes the user volume for a WorkSpace bundle. Type: [UserStorage](API_UserStorage.md) object Required: Yes ## Response Syntax ``` { "WorkspaceBundle": { "BundleId": "string", "BundleType": "string", "ComputeType": { "Name": "string" }, "CreationTime": number, "Description": "string", "ImageId": "string", "LastUpdatedTime": number, "Name": "string", "Owner": "string", "RootStorage": { "Capacity": "string" }, "State": "string", "UserStorage": { "Capacity": "string" } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [WorkspaceBundle](#API_CreateWorkspaceBundle_ResponseSyntax) ** Describes a WorkSpace bundle. Type: [WorkspaceBundle](API_WorkspaceBundle.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ResourceUnavailableException ** The specified resource is not available. ** message ** The exception error message. ** ResourceId ** The identifier of the resource that is not available. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateWorkspaceBundle) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateWorkspaceBundle) # CreateWorkspaceImage Creates a new WorkSpace image from an existing WorkSpace. ## Request Syntax ``` { "Description": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "WorkspaceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Description](#API_CreateWorkspaceImage_RequestSyntax) ** The description of the new WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9_./() -]+$` Required: Yes ** [Name](#API_CreateWorkspaceImage_RequestSyntax) ** The name of the new WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_./()\\-]+$` Required: Yes ** [Tags](#API_CreateWorkspaceImage_RequestSyntax) ** The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use `workspaces:CreateTags`. Type: Array of [Tag](API_Tag.md) objects Required: No ** [WorkspaceId](#API_CreateWorkspaceImage_RequestSyntax) ** The identifier of the source WorkSpace Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ## Response Syntax ``` { "Created": number, "Description": "string", "ImageId": "string", "Name": "string", "OperatingSystem": { "Type": "string" }, "OwnerAccountId": "string", "RequiredTenancy": "string", "State": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Created](#API_CreateWorkspaceImage_ResponseSyntax) ** The date when the image was created. Type: Timestamp ** [Description](#API_CreateWorkspaceImage_ResponseSyntax) ** The description of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9_./() -]+$` ** [ImageId](#API_CreateWorkspaceImage_ResponseSyntax) ** The identifier of the new WorkSpace image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` ** [Name](#API_CreateWorkspaceImage_ResponseSyntax) ** The name of the image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_./()\\-]+$` ** [OperatingSystem](#API_CreateWorkspaceImage_ResponseSyntax) ** The operating system that the image is running. Type: [OperatingSystem](API_OperatingSystem.md) object ** [OwnerAccountId](#API_CreateWorkspaceImage_ResponseSyntax) ** The identifier of the AWS account that owns the image. Type: String Pattern: `^\d{12}$` ** [RequiredTenancy](#API_CreateWorkspaceImage_ResponseSyntax) ** Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see [ Bring Your Own Windows Desktop Images.](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm). Type: String Valid Values: `DEFAULT | DEDICATED` ** [State](#API_CreateWorkspaceImage_ResponseSyntax) ** The availability status of the image. Type: String Valid Values: `AVAILABLE | PENDING | ERROR` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateWorkspaceImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateWorkspaceImage) # CreateWorkspaces Creates one or more WorkSpaces. This operation is asynchronous and returns before the WorkSpaces are created. **Note** 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](http://aws.amazon.com/workspaces/core/). You don't need to specify the `PCOIP` protocol for Linux bundles because `DCV` (formerly WSP) is the default protocol for those bundles. User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core. Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see [ Can I switch between hourly and monthly billing?](http://aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F) ## Request Syntax ``` { "Workspaces": [ { "BundleId": "string", "DirectoryId": "string", "Ipv6Address": "string", "RootVolumeEncryptionEnabled": boolean, "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Workspaces](#API_CreateWorkspaces_RequestSyntax) ** The WorkSpaces to create. You can specify up to 25 WorkSpaces. Type: Array of [WorkspaceRequest](API_WorkspaceRequest.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes ## Response Syntax ``` { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceRequest": { "BundleId": "string", "DirectoryId": "string", "Ipv6Address": "string", "RootVolumeEncryptionEnabled": boolean, "Tags": [ { "Key": "string", "Value": "string" } ], "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } } ], "PendingRequests": [ { "BundleId": "string", "ComputerName": "string", "DataReplicationSettings": { "DataReplication": "string", "RecoverySnapshotTime": number }, "DirectoryId": "string", "ErrorCode": "string", "ErrorMessage": "string", "IpAddress": "string", "Ipv6Address": "string", "ModificationStates": [ { "Resource": "string", "State": "string" } ], "RelatedWorkspaces": [ { "Region": "string", "State": "string", "Type": "string", "WorkspaceId": "string" } ], "RootVolumeEncryptionEnabled": boolean, "StandbyWorkspacesProperties": [ { "DataReplication": "string", "RecoverySnapshotTime": number, "StandbyWorkspaceId": "string" } ], "State": "string", "SubnetId": "string", "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceId": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FailedRequests](#API_CreateWorkspaces_ResponseSyntax) ** Information about the WorkSpaces that could not be created. Type: Array of [FailedCreateWorkspaceRequest](API_FailedCreateWorkspaceRequest.md) objects ** [PendingRequests](#API_CreateWorkspaces_ResponseSyntax) ** 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](API_DescribeWorkspaces.md) before the WorkSpace is created, the information returned can be incomplete. Type: Array of [Workspace](API_Workspace.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateWorkspaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateWorkspaces) # CreateWorkspacesPool Creates a pool of WorkSpaces. ## Request Syntax ``` { "ApplicationSettings": { "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "Capacity": { "DesiredUserSessions": number }, "Description": "string", "DirectoryId": "string", "PoolName": "string", "RunningMode": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TimeoutSettings": { "DisconnectTimeoutInSeconds": number, "IdleDisconnectTimeoutInSeconds": number, "MaxUserDurationInSeconds": number } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationSettings](#API_CreateWorkspacesPool_RequestSyntax) ** Indicates the application settings of the pool. Type: [ApplicationSettingsRequest](API_ApplicationSettingsRequest.md) object Required: No ** [BundleId](#API_CreateWorkspacesPool_RequestSyntax) ** The identifier of the bundle for the pool. Type: String Pattern: `^wsb-[0-9a-z]{8,63}$` Required: Yes ** [Capacity](#API_CreateWorkspacesPool_RequestSyntax) ** The user capacity of the pool. Type: [Capacity](API_Capacity.md) object Required: Yes ** [Description](#API_CreateWorkspacesPool_RequestSyntax) ** The pool description. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z0-9_./() -]+$` Required: Yes ** [DirectoryId](#API_CreateWorkspacesPool_RequestSyntax) ** The identifier of the directory for the pool. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [PoolName](#API_CreateWorkspacesPool_RequestSyntax) ** The name of the pool. Type: String Pattern: `^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$` Required: Yes ** [RunningMode](#API_CreateWorkspacesPool_RequestSyntax) ** The running mode for the pool. Type: String Valid Values: `AUTO_STOP | ALWAYS_ON` Required: No ** [Tags](#API_CreateWorkspacesPool_RequestSyntax) ** The tags for the pool. Type: Array of [Tag](API_Tag.md) objects Required: No ** [TimeoutSettings](#API_CreateWorkspacesPool_RequestSyntax) ** Indicates the timeout settings of the pool. Type: [TimeoutSettings](API_TimeoutSettings.md) object Required: No ## Response Syntax ``` { "WorkspacesPool": { "ApplicationSettings": { "S3BucketName": "string", "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "CapacityStatus": { "ActiveUserSessions": number, "ActualUserSessions": number, "AvailableUserSessions": number, "DesiredUserSessions": number }, "CreatedAt": number, "Description": "string", "DirectoryId": "string", "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "PoolArn": "string", "PoolId": "string", "PoolName": "string", "RunningMode": "string", "State": "string", "TimeoutSettings": { "DisconnectTimeoutInSeconds": number, "IdleDisconnectTimeoutInSeconds": number, "MaxUserDurationInSeconds": number } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [WorkspacesPool](#API_CreateWorkspacesPool_ResponseSyntax) ** Indicates the pool to create. Type: [WorkspacesPool](API_WorkspacesPool.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/CreateWorkspacesPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/CreateWorkspacesPool) # DeleteAccountLinkInvitation Deletes the account link invitation. ## Request Syntax ``` { "ClientToken": "string", "LinkId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ClientToken](#API_DeleteAccountLinkInvitation_RequestSyntax) ** A string of up to 64 ASCII characters that Amazon WorkSpaces uses to ensure idempotent creation. Type: String Pattern: `^.{1,64}$` Required: No ** [LinkId](#API_DeleteAccountLinkInvitation_RequestSyntax) ** The identifier of the account link. Type: String Pattern: `^link-.{8,24}$` Required: Yes ## Response Syntax ``` { "AccountLink": { "AccountLinkId": "string", "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AccountLink](#API_DeleteAccountLinkInvitation_ResponseSyntax) ** Information about the account link. Type: [AccountLink](API_AccountLink.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** ConflictException ** The `TargetAccountId` is already linked or invited. HTTP Status Code: 400 ** InternalServerException ** Unexpected server error occured. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ValidationException ** You either haven't provided a `TargetAccountId` or are using the same value for `TargetAccountId` and `SourceAccountId`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeleteAccountLinkInvitation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeleteAccountLinkInvitation) # DeleteClientBranding 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. ## Request Syntax ``` { "Platforms": [ "string" ], "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Platforms](#API_DeleteClientBranding_RequestSyntax) ** The device type for which you want to delete client branding. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 6 items. Valid Values: `DeviceTypeWindows | DeviceTypeOsx | DeviceTypeAndroid | DeviceTypeIos | DeviceTypeLinux | DeviceTypeWeb` Required: Yes ** [ResourceId](#API_DeleteClientBranding_RequestSyntax) ** The directory identifier of the WorkSpace for which you want to delete client branding. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeleteClientBranding) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeleteClientBranding) # DeleteConnectClientAddIn Deletes a client-add-in for Amazon Connect that is configured within a directory. ## Request Syntax ``` { "AddInId": "string", "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AddInId](#API_DeleteConnectClientAddIn_RequestSyntax) ** The identifier of the client add-in to delete. Type: String Length Constraints: Fixed length of 36. Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Required: Yes ** [ResourceId](#API_DeleteConnectClientAddIn_RequestSyntax) ** The directory identifier for which the client add-in is configured. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeleteConnectClientAddIn) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeleteConnectClientAddIn) # DeleteConnectionAlias Deletes the specified connection alias. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). **Important** **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](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations). **Note** 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. ## Request Syntax ``` { "AliasId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AliasId](#API_DeleteConnectionAlias_RequestSyntax) ** The identifier of the connection alias to delete. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: `^wsca-[0-9a-z]{8,63}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAssociatedException ** The resource is associated with a directory. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeleteConnectionAlias) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeleteConnectionAlias) # DeleteIpGroup Deletes the specified IP access control group. You cannot delete an IP access control group that is associated with a directory. ## Request Syntax ``` { "GroupId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [GroupId](#API_DeleteIpGroup_RequestSyntax) ** The identifier of the IP access control group. Type: String Pattern: `wsipg-[0-9a-z]{8,63}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceAssociatedException ** The resource is associated with a directory. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeleteIpGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeleteIpGroup) # DeleteTags Deletes the specified tags from the specified WorkSpaces resource. ## Request Syntax ``` { "ResourceId": "string", "TagKeys": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceId](#API_DeleteTags_RequestSyntax) ** The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases. Type: String Length Constraints: Minimum length of 1. Required: Yes ** [TagKeys](#API_DeleteTags_RequestSyntax) ** The tag keys. Type: Array of strings Length Constraints: Minimum length of 1. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeleteTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeleteTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeleteTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeleteTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeleteTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeleteTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeleteTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeleteTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeleteTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeleteTags) # DeleteWorkspaceBundle Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see [ Delete a Custom WorkSpaces Bundle or Image](https://docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html). ## Request Syntax ``` { "BundleId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [BundleId](#API_DeleteWorkspaceBundle_RequestSyntax) ** The identifier of the bundle. Type: String Pattern: `^wsb-[0-9a-z]{8,63}$` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceAssociatedException ** The resource is associated with a directory. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeleteWorkspaceBundle) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeleteWorkspaceBundle) # DeleteWorkspaceImage 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. ## Request Syntax ``` { "ImageId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ImageId](#API_DeleteWorkspaceImage_RequestSyntax) ** The identifier of the image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** ResourceAssociatedException ** The resource is associated with a directory. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeleteWorkspaceImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeleteWorkspaceImage) # DeployWorkspaceApplications Deploys associated applications to the specified WorkSpace ## Request Syntax ``` { "Force": boolean, "WorkspaceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Force](#API_DeployWorkspaceApplications_RequestSyntax) ** Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried. Type: Boolean Required: No ** [WorkspaceId](#API_DeployWorkspaceApplications_RequestSyntax) ** The identifier of the WorkSpace. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ## Response Syntax ``` { "Deployment": { "Associations": [ { "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "string" }, "WorkspaceId": "string" } ] } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Deployment](#API_DeployWorkspaceApplications_ResponseSyntax) ** The list of deployed associations and information about them. Type: [WorkSpaceApplicationDeployment](API_WorkSpaceApplicationDeployment.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** IncompatibleApplicationsException ** The specified application is not compatible with the resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is currently in use. ** ResourceId ** The ID of the resource that is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeployWorkspaceApplications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeployWorkspaceApplications) # DeregisterWorkspaceDirectory 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. **Note** 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](http://aws.amazon.com/directoryservice/pricing/). To delete empty directories, see [ Delete the Directory for Your WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). 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. ## Request Syntax ``` { "DirectoryId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DirectoryId](#API_DeregisterWorkspaceDirectory_RequestSyntax) ** 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. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DeregisterWorkspaceDirectory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DeregisterWorkspaceDirectory) # DescribeAccount Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account. ## Response Syntax ``` { "DedicatedTenancyAccountType": "string", "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string", "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DedicatedTenancyAccountType](#API_DescribeAccount_ResponseSyntax) ** The type of linked account. Type: String Valid Values: `SOURCE_ACCOUNT | TARGET_ACCOUNT` ** [DedicatedTenancyManagementCidrRange](#API_DescribeAccount_ResponseSyntax) ** 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. Type: String Pattern: `(^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.0\.0)(\/(16$))$` ** [DedicatedTenancySupport](#API_DescribeAccount_ResponseSyntax) ** The status of BYOL (whether BYOL is enabled or disabled). Type: String Valid Values: `ENABLED | DISABLED` ** [Message](#API_DescribeAccount_ResponseSyntax) ** The text message to describe the status of BYOL. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeAccount) # DescribeAccountModifications Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account. ## Request Syntax ``` { "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [NextToken](#API_DescribeAccountModifications_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ## Response Syntax ``` { "AccountModifications": [ { "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string", "ErrorCode": "string", "ErrorMessage": "string", "ModificationState": "string", "StartTime": number } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AccountModifications](#API_DescribeAccountModifications_ResponseSyntax) ** The list of modifications to the configuration of BYOL. Type: Array of [AccountModification](API_AccountModification.md) objects ** [NextToken](#API_DescribeAccountModifications_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeAccountModifications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeAccountModifications) # DescribeApplicationAssociations Describes the associations between the application and the specified associated resources. ## Request Syntax ``` { "ApplicationId": "string", "AssociatedResourceTypes": [ "string" ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationId](#API_DescribeApplicationAssociations_RequestSyntax) ** The identifier of the specified application. Type: String Pattern: `^wsa-[0-9a-z]{8,63}$` Required: Yes ** [AssociatedResourceTypes](#API_DescribeApplicationAssociations_RequestSyntax) ** The resource type of the associated resources. Type: Array of strings Valid Values: `WORKSPACE | BUNDLE | IMAGE` Required: Yes ** [MaxResults](#API_DescribeApplicationAssociations_RequestSyntax) ** The maximum number of associations to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeApplicationAssociations_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ## Response Syntax ``` { "Associations": [ { "ApplicationId": "string", "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Associations](#API_DescribeApplicationAssociations_ResponseSyntax) ** List of associations and information about them. Type: Array of [ApplicationResourceAssociation](API_ApplicationResourceAssociation.md) objects ** [NextToken](#API_DescribeApplicationAssociations_ResponseSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeApplicationAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeApplicationAssociations) # DescribeApplications Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners. ## Request Syntax ``` { "ApplicationIds": [ "string" ], "ComputeTypeNames": [ "string" ], "LicenseType": "string", "MaxResults": number, "NextToken": "string", "OperatingSystemNames": [ "string" ], "Owner": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationIds](#API_DescribeApplications_RequestSyntax) ** The identifiers of one or more applications. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: `^wsa-[0-9a-z]{8,63}$` Required: No ** [ComputeTypeNames](#API_DescribeApplications_RequestSyntax) ** The compute types supported by the applications. Type: Array of strings Valid Values: `VALUE | STANDARD | PERFORMANCE | POWER | GRAPHICS | POWERPRO | GENERALPURPOSE_4XLARGE | GENERALPURPOSE_8XLARGE | GRAPHICSPRO | GRAPHICS_G4DN | GRAPHICSPRO_G4DN | GRAPHICS_G6_XLARGE | GRAPHICS_G6_2XLARGE | GRAPHICS_G6_4XLARGE | GRAPHICS_G6_8XLARGE | GRAPHICS_G6_16XLARGE | GRAPHICS_GR6_4XLARGE | GRAPHICS_GR6_8XLARGE | GRAPHICS_G6F_LARGE | GRAPHICS_G6F_XLARGE | GRAPHICS_G6F_2XLARGE | GRAPHICS_G6F_4XLARGE | GRAPHICS_GR6F_4XLARGE` Required: No ** [LicenseType](#API_DescribeApplications_RequestSyntax) ** The license availability for the applications. Type: String Valid Values: `LICENSED | UNLICENSED` Required: No ** [MaxResults](#API_DescribeApplications_RequestSyntax) ** The maximum number of applications to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeApplications_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [OperatingSystemNames](#API_DescribeApplications_RequestSyntax) ** The operating systems supported by the applications. Type: Array of strings Valid Values: `AMAZON_LINUX_2 | UBUNTU_18_04 | UBUNTU_20_04 | UBUNTU_22_04 | UNKNOWN | WINDOWS_10 | WINDOWS_11 | WINDOWS_7 | WINDOWS_SERVER_2016 | WINDOWS_SERVER_2019 | WINDOWS_SERVER_2022 | RHEL_8 | ROCKY_8` Required: No ** [Owner](#API_DescribeApplications_RequestSyntax) ** The owner of the applications. Type: String Pattern: `^\d{12}|AMAZON$` Required: No ## Response Syntax ``` { "Applications": [ { "ApplicationId": "string", "Created": number, "Description": "string", "LicenseType": "string", "Name": "string", "Owner": "string", "State": "string", "SupportedComputeTypeNames": [ "string" ], "SupportedOperatingSystemNames": [ "string" ] } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Applications](#API_DescribeApplications_ResponseSyntax) ** List of information about the specified applications. Type: Array of [WorkSpaceApplication](API_WorkSpaceApplication.md) objects ** [NextToken](#API_DescribeApplications_ResponseSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeApplications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeApplications) # DescribeBundleAssociations Describes the associations between the applications and the specified bundle. ## Request Syntax ``` { "AssociatedResourceTypes": [ "string" ], "BundleId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AssociatedResourceTypes](#API_DescribeBundleAssociations_RequestSyntax) ** The resource types of the associated resource. Type: Array of strings Valid Values: `APPLICATION` Required: Yes ** [BundleId](#API_DescribeBundleAssociations_RequestSyntax) ** The identifier of the bundle. Type: String Pattern: `^wsb-[0-9a-z]{8,63}$` Required: Yes ## Response Syntax ``` { "Associations": [ { "AssociatedResourceId": "string", "AssociatedResourceType": "string", "BundleId": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Associations](#API_DescribeBundleAssociations_ResponseSyntax) ** List of information about the specified associations. Type: Array of [BundleResourceAssociation](API_BundleResourceAssociation.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeBundleAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeBundleAssociations) # DescribeClientBranding 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. **Note** Only device types that have branding information configured will be shown in the response. ## Request Syntax ``` { "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceId](#API_DescribeClientBranding_RequestSyntax) ** The directory identifier of the WorkSpace for which you want to view client branding information. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ## Response Syntax ``` { "DeviceTypeAndroid": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeIos": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo2xUrl": "string", "Logo3xUrl": "string", "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeLinux": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeOsx": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWeb": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWindows": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DeviceTypeAndroid](#API_DescribeClientBranding_ResponseSyntax) ** The branding information for Android devices. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ** [DeviceTypeIos](#API_DescribeClientBranding_ResponseSyntax) ** The branding information for iOS devices. Type: [IosClientBrandingAttributes](API_IosClientBrandingAttributes.md) object ** [DeviceTypeLinux](#API_DescribeClientBranding_ResponseSyntax) ** The branding information for Linux devices. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ** [DeviceTypeOsx](#API_DescribeClientBranding_ResponseSyntax) ** The branding information for macOS devices. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ** [DeviceTypeWeb](#API_DescribeClientBranding_ResponseSyntax) ** The branding information for Web access. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ** [DeviceTypeWindows](#API_DescribeClientBranding_ResponseSyntax) ** The branding information for Windows devices. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeClientBranding) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeClientBranding) # DescribeClientProperties Retrieves a list that describes one or more specified Amazon WorkSpaces clients. ## Request Syntax ``` { "ResourceIds": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceIds](#API_DescribeClientProperties_RequestSyntax) ** The resource identifier, in the form of directory IDs. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Length Constraints: Minimum length of 1. Required: Yes ## Response Syntax ``` { "ClientPropertiesList": [ { "ClientProperties": { "LogUploadEnabled": "string", "ReconnectEnabled": "string" }, "ResourceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ClientPropertiesList](#API_DescribeClientProperties_ResponseSyntax) ** Information about the specified Amazon WorkSpaces clients. Type: Array of [ClientPropertiesResult](API_ClientPropertiesResult.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeClientProperties) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeClientProperties) # DescribeConnectClientAddIns Retrieves a list of Amazon Connect client add-ins that have been created. ## Request Syntax ``` { "MaxResults": number, "NextToken": "string", "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [MaxResults](#API_DescribeConnectClientAddIns_RequestSyntax) ** The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeConnectClientAddIns_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [ResourceId](#API_DescribeConnectClientAddIns_RequestSyntax) ** The directory identifier for which the client add-in is configured. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ## Response Syntax ``` { "AddIns": [ { "AddInId": "string", "Name": "string", "ResourceId": "string", "URL": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AddIns](#API_DescribeConnectClientAddIns_ResponseSyntax) ** Information about client add-ins. Type: Array of [ConnectClientAddIn](API_ConnectClientAddIn.md) objects ** [NextToken](#API_DescribeConnectClientAddIns_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeConnectClientAddIns) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeConnectClientAddIns) # DescribeConnectionAliases Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). ## Request Syntax ``` { "AliasIds": [ "string" ], "Limit": number, "NextToken": "string", "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AliasIds](#API_DescribeConnectionAliases_RequestSyntax) ** The identifiers of the connection aliases to describe. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: `^wsca-[0-9a-z]{8,63}$` Required: No ** [Limit](#API_DescribeConnectionAliases_RequestSyntax) ** The maximum number of connection aliases to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeConnectionAliases_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [ResourceId](#API_DescribeConnectionAliases_RequestSyntax) ** The identifier of the directory associated with the connection alias. Type: String Length Constraints: Minimum length of 1. Required: No ## Response Syntax ``` { "ConnectionAliases": [ { "AliasId": "string", "Associations": [ { "AssociatedAccountId": "string", "AssociationStatus": "string", "ConnectionIdentifier": "string", "ResourceId": "string" } ], "ConnectionString": "string", "OwnerAccountId": "string", "State": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ConnectionAliases](#API_DescribeConnectionAliases_ResponseSyntax) ** Information about the specified connection aliases. Type: Array of [ConnectionAlias](API_ConnectionAlias.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. ** [NextToken](#API_DescribeConnectionAliases_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeConnectionAliases) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeConnectionAliases) # DescribeConnectionAliasPermissions Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see [ Cross-Region Redirection for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). ## Request Syntax ``` { "AliasId": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AliasId](#API_DescribeConnectionAliasPermissions_RequestSyntax) ** The identifier of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: `^wsca-[0-9a-z]{8,63}$` Required: Yes ** [MaxResults](#API_DescribeConnectionAliasPermissions_RequestSyntax) ** The maximum number of results to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeConnectionAliasPermissions_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ## Response Syntax ``` { "AliasId": "string", "ConnectionAliasPermissions": [ { "AllowAssociation": boolean, "SharedAccountId": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AliasId](#API_DescribeConnectionAliasPermissions_ResponseSyntax) ** The identifier of the connection alias. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: `^wsca-[0-9a-z]{8,63}$` ** [ConnectionAliasPermissions](#API_DescribeConnectionAliasPermissions_ResponseSyntax) ** The permissions associated with a connection alias. Type: Array of [ConnectionAliasPermission](API_ConnectionAliasPermission.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. ** [NextToken](#API_DescribeConnectionAliasPermissions_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeConnectionAliasPermissions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeConnectionAliasPermissions) # DescribeCustomWorkspaceImageImport Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage. ## Request Syntax ``` { "ImageId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ImageId](#API_DescribeCustomWorkspaceImageImport_RequestSyntax) ** The identifier of the WorkSpace image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: Yes ## Response Syntax ``` { "Created": number, "ErrorDetails": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "ImageBuilderInstanceId": "string", "ImageId": "string", "ImageSource": { ... }, "InfrastructureConfigurationArn": "string", "LastUpdatedTime": number, "ProgressPercentage": number, "State": "string", "StateMessage": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Created](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** The timestamp when the WorkSpace image import was created. Type: Timestamp ** [ErrorDetails](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information. Type: Array of [CustomWorkspaceImageImportErrorDetails](API_CustomWorkspaceImageImportErrorDetails.md) objects ** [ImageBuilderInstanceId](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** The image builder instance ID of the WorkSpace image. Type: String Length Constraints: Minimum length of 1. ** [ImageId](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** The identifier of the WorkSpace image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` ** [ImageSource](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** Describes the image import source. Type: [ImageSourceIdentifier](API_ImageSourceIdentifier.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. ** [InfrastructureConfigurationArn](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** The infrastructure configuration ARN that specifies how the WorkSpace image is built. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$` ** [LastUpdatedTime](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** The timestamp when the WorkSpace image import was last updated. Type: Timestamp ** [ProgressPercentage](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** The estimated progress percentage of the WorkSpace image import workflow. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. ** [State](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** The state of the WorkSpace image. Type: String Valid Values: `PENDING | IN_PROGRESS | PROCESSING_SOURCE_IMAGE | IMAGE_TESTING_START | UPDATING_OPERATING_SYSTEM | IMAGE_COMPATIBILITY_CHECKING | IMAGE_TESTING_GENERALIZATION | CREATING_TEST_INSTANCE | INSTALLING_COMPONENTS | GENERALIZING | VALIDATING | PUBLISHING | COMPLETED | ERROR` ** [StateMessage](#API_DescribeCustomWorkspaceImageImport_ResponseSyntax) ** The state message of the WorkSpace image import workflow. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeCustomWorkspaceImageImport) # DescribeImageAssociations Describes the associations between the applications and the specified image. ## Request Syntax ``` { "AssociatedResourceTypes": [ "string" ], "ImageId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AssociatedResourceTypes](#API_DescribeImageAssociations_RequestSyntax) ** The resource types of the associated resource. Type: Array of strings Valid Values: `APPLICATION` Required: Yes ** [ImageId](#API_DescribeImageAssociations_RequestSyntax) ** The identifier of the image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: Yes ## Response Syntax ``` { "Associations": [ { "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "ImageId": "string", "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "string" } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Associations](#API_DescribeImageAssociations_ResponseSyntax) ** List of information about the specified associations. Type: Array of [ImageResourceAssociation](API_ImageResourceAssociation.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeImageAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeImageAssociations) # DescribeIpGroups Describes one or more of your IP access control groups. ## Request Syntax ``` { "GroupIds": [ "string" ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [GroupIds](#API_DescribeIpGroups_RequestSyntax) ** The identifiers of one or more IP access control groups. Type: Array of strings Pattern: `wsipg-[0-9a-z]{8,63}$` Required: No ** [MaxResults](#API_DescribeIpGroups_RequestSyntax) ** The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeIpGroups_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ## Response Syntax ``` { "NextToken": "string", "Result": [ { "groupDesc": "string", "groupId": "string", "groupName": "string", "userRules": [ { "ipRule": "string", "ruleDesc": "string" } ] } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribeIpGroups_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [Result](#API_DescribeIpGroups_ResponseSyntax) ** Information about the IP access control groups. Type: Array of [WorkspacesIpGroup](API_WorkspacesIpGroup.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeIpGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeIpGroups) # DescribeTags Describes the specified tags for the specified WorkSpaces resource. ## Request Syntax ``` { "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceId](#API_DescribeTags_RequestSyntax) ** The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases. Type: String Length Constraints: Minimum length of 1. Required: Yes ## Response Syntax ``` { "TagList": [ { "Key": "string", "Value": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [TagList](#API_DescribeTags_ResponseSyntax) ** The tags. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeTags) # DescribeWorkspaceAssociations Describes the associations betweens applications and the specified WorkSpace. ## Request Syntax ``` { "AssociatedResourceTypes": [ "string" ], "WorkspaceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AssociatedResourceTypes](#API_DescribeWorkspaceAssociations_RequestSyntax) ** The resource types of the associated resources. Type: Array of strings Valid Values: `APPLICATION` Required: Yes ** [WorkspaceId](#API_DescribeWorkspaceAssociations_RequestSyntax) ** The identifier of the WorkSpace. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ## Response Syntax ``` { "Associations": [ { "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "string" }, "WorkspaceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Associations](#API_DescribeWorkspaceAssociations_ResponseSyntax) ** List of information about the specified associations. Type: Array of [WorkspaceResourceAssociation](API_WorkspaceResourceAssociation.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspaceAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspaceAssociations) # DescribeWorkspaceBundles Retrieves a list that describes the available WorkSpace bundles. You can filter the results using either bundle ID or owner, but not both. ## Request Syntax ``` { "BundleIds": [ "string" ], "NextToken": "string", "Owner": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [BundleIds](#API_DescribeWorkspaceBundles_RequestSyntax) ** The identifiers of the bundles. You cannot combine this parameter with any other filter. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: `^wsb-[0-9a-z]{8,63}$` Required: No ** [NextToken](#API_DescribeWorkspaceBundles_RequestSyntax) ** The token for the next set of results. (You received this token from a previous call.) Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [Owner](#API_DescribeWorkspaceBundles_RequestSyntax) ** The owner of the bundles. You cannot combine this parameter with any other filter. To describe the bundles provided by AWS, specify `AMAZON`. To describe the bundles that belong to your account, don't specify a value. Type: String Required: No ## Response Syntax ``` { "Bundles": [ { "BundleId": "string", "BundleType": "string", "ComputeType": { "Name": "string" }, "CreationTime": number, "Description": "string", "ImageId": "string", "LastUpdatedTime": number, "Name": "string", "Owner": "string", "RootStorage": { "Capacity": "string" }, "State": "string", "UserStorage": { "Capacity": "string" } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Bundles](#API_DescribeWorkspaceBundles_ResponseSyntax) ** Information about the bundles. Type: Array of [WorkspaceBundle](API_WorkspaceBundle.md) objects ** [NextToken](#API_DescribeWorkspaceBundles_ResponseSyntax) ** 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspaceBundles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspaceBundles) # DescribeWorkspaceDirectories Describes the available directories that are registered with Amazon WorkSpaces. ## Request Syntax ``` { "DirectoryIds": [ "string" ], "Filters": [ { "Name": "string", "Values": [ "string" ] } ], "Limit": number, "NextToken": "string", "WorkspaceDirectoryNames": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DirectoryIds](#API_DescribeWorkspaceDirectories_RequestSyntax) ** The identifiers of the directories. If the value is null, all directories are retrieved. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: No ** [Filters](#API_DescribeWorkspaceDirectories_RequestSyntax) ** The filter condition for the WorkSpaces. Type: Array of [DescribeWorkspaceDirectoriesFilter](API_DescribeWorkspaceDirectoriesFilter.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: No ** [Limit](#API_DescribeWorkspaceDirectories_RequestSyntax) ** The maximum number of directories to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeWorkspaceDirectories_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [WorkspaceDirectoryNames](#API_DescribeWorkspaceDirectories_RequestSyntax) ** The names of the WorkSpace directories. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: `^[a-zA-Z0-9][a-zA-Z0-9_.\s-]{1,64}$` Required: No ## Response Syntax ``` { "Directories": [ { "ActiveDirectoryConfig": { "DomainName": "string", "ServiceAccountSecretArn": "string" }, "Alias": "string", "CertificateBasedAuthProperties": { "CertificateAuthorityArn": "string", "Status": "string" }, "CustomerUserName": "string", "DirectoryId": "string", "DirectoryName": "string", "DirectoryType": "string", "DnsIpAddresses": [ "string" ], "DnsIpv6Addresses": [ "string" ], "EndpointEncryptionMode": "string", "ErrorMessage": "string", "IamRoleId": "string", "IDCConfig": { "ApplicationArn": "string", "InstanceArn": "string" }, "ipGroupIds": [ "string" ], "MicrosoftEntraConfig": { "ApplicationConfigSecretArn": "string", "TenantId": "string" }, "RegistrationCode": "string", "SamlProperties": { "RelayStateParameterName": "string", "Status": "string", "UserAccessUrl": "string" }, "SelfservicePermissions": { "ChangeComputeType": "string", "IncreaseVolumeSize": "string", "RebuildWorkspace": "string", "RestartWorkspace": "string", "SwitchRunningMode": "string" }, "State": "string", "StreamingProperties": { "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "StorageConnectors": [ { "ConnectorType": "string", "Status": "string" } ], "StreamingExperiencePreferredProtocol": "string", "UserSettings": [ { "Action": "string", "MaximumLength": number, "Permission": "string" } ] }, "SubnetIds": [ "string" ], "Tenancy": "string", "UserIdentityType": "string", "WorkspaceAccessProperties": { "AccessEndpointConfig": { "AccessEndpoints": [ { "AccessEndpointType": "string", "VpcEndpointId": "string" } ], "InternetFallbackProtocols": [ "string" ] }, "DeviceTypeAndroid": "string", "DeviceTypeChromeOs": "string", "DeviceTypeIos": "string", "DeviceTypeLinux": "string", "DeviceTypeOsx": "string", "DeviceTypeWeb": "string", "DeviceTypeWindows": "string", "DeviceTypeWorkSpacesThinClient": "string", "DeviceTypeZeroClient": "string" }, "WorkspaceCreationProperties": { "CustomSecurityGroupId": "string", "DefaultOu": "string", "EnableInternetAccess": boolean, "EnableMaintenanceMode": boolean, "InstanceIamRoleArn": "string", "UserEnabledAsLocalAdministrator": boolean }, "WorkspaceDirectoryDescription": "string", "WorkspaceDirectoryName": "string", "WorkspaceSecurityGroupId": "string", "WorkspaceType": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Directories](#API_DescribeWorkspaceDirectories_ResponseSyntax) ** Information about the directories. Type: Array of [WorkspaceDirectory](API_WorkspaceDirectory.md) objects ** [NextToken](#API_DescribeWorkspaceDirectories_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspaceDirectories) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspaceDirectories) # DescribeWorkspaceImagePermissions Describes the permissions that the owner of an image has granted to other AWS accounts for an image. ## Request Syntax ``` { "ImageId": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ImageId](#API_DescribeWorkspaceImagePermissions_RequestSyntax) ** The identifier of the image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: Yes ** [MaxResults](#API_DescribeWorkspaceImagePermissions_RequestSyntax) ** The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeWorkspaceImagePermissions_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ## Response Syntax ``` { "ImageId": "string", "ImagePermissions": [ { "SharedAccountId": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageId](#API_DescribeWorkspaceImagePermissions_ResponseSyntax) ** The identifier of the image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` ** [ImagePermissions](#API_DescribeWorkspaceImagePermissions_ResponseSyntax) ** The identifiers of the AWS accounts that the image has been shared with. Type: Array of [ImagePermission](API_ImagePermission.md) objects ** [NextToken](#API_DescribeWorkspaceImagePermissions_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspaceImagePermissions) # DescribeWorkspaceImages Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described. ## Request Syntax ``` { "ImageIds": [ "string" ], "ImageType": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ImageIds](#API_DescribeWorkspaceImages_RequestSyntax) ** The identifier of the image. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: `wsi-[0-9a-z]{9,63}$` Required: No ** [ImageType](#API_DescribeWorkspaceImages_RequestSyntax) ** The type (owned or shared) of the image. Type: String Valid Values: `OWNED | SHARED` Required: No ** [MaxResults](#API_DescribeWorkspaceImages_RequestSyntax) ** The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeWorkspaceImages_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ## Response Syntax ``` { "Images": [ { "Created": number, "Description": "string", "ErrorCode": "string", "ErrorDetails": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "ErrorMessage": "string", "ImageId": "string", "Name": "string", "OperatingSystem": { "Type": "string" }, "OwnerAccountId": "string", "RequiredTenancy": "string", "State": "string", "Updates": { "Description": "string", "UpdateAvailable": boolean } } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Images](#API_DescribeWorkspaceImages_ResponseSyntax) ** Information about the images. Type: Array of [WorkspaceImage](API_WorkspaceImage.md) objects ** [NextToken](#API_DescribeWorkspaceImages_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspaceImages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspaceImages) # DescribeWorkspaces 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. ## Request Syntax ``` { "BundleId": "string", "DirectoryId": "string", "Limit": number, "NextToken": "string", "UserName": "string", "WorkspaceIds": [ "string" ], "WorkspaceName": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [BundleId](#API_DescribeWorkspaces_RequestSyntax) ** The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter. Type: String Pattern: `^wsb-[0-9a-z]{8,63}$` Required: No ** [DirectoryId](#API_DescribeWorkspaces_RequestSyntax) ** The identifier of the directory. In addition, you can optionally specify a specific directory user (see `UserName`). You cannot combine this parameter with any other filter. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: No ** [Limit](#API_DescribeWorkspaces_RequestSyntax) ** The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeWorkspaces_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [UserName](#API_DescribeWorkspaces_RequestSyntax) ** The name of the directory user. You must specify this parameter with `DirectoryId`. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Required: No ** [WorkspaceIds](#API_DescribeWorkspaces_RequestSyntax) ** The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter. Because the [CreateWorkspaces](API_CreateWorkspaces.md) operation is asynchronous, the identifier it returns is not immediately available. If you immediately call [DescribeWorkspaces](#API_DescribeWorkspaces) with this identifier, no information is returned. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: `^ws-[0-9a-z]{8,63}$` Required: No ** [WorkspaceName](#API_DescribeWorkspaces_RequestSyntax) ** The name of the user-decoupled WorkSpace. Type: String Pattern: `^[a-zA-Z0-9_()][a-zA-Z0-9_.()-]{1,63}$` Required: No ## Response Syntax ``` { "NextToken": "string", "Workspaces": [ { "BundleId": "string", "ComputerName": "string", "DataReplicationSettings": { "DataReplication": "string", "RecoverySnapshotTime": number }, "DirectoryId": "string", "ErrorCode": "string", "ErrorMessage": "string", "IpAddress": "string", "Ipv6Address": "string", "ModificationStates": [ { "Resource": "string", "State": "string" } ], "RelatedWorkspaces": [ { "Region": "string", "State": "string", "Type": "string", "WorkspaceId": "string" } ], "RootVolumeEncryptionEnabled": boolean, "StandbyWorkspacesProperties": [ { "DataReplication": "string", "RecoverySnapshotTime": number, "StandbyWorkspaceId": "string" } ], "State": "string", "SubnetId": "string", "UserName": "string", "UserVolumeEncryptionEnabled": boolean, "VolumeEncryptionKey": "string", "WorkspaceId": "string", "WorkspaceName": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribeWorkspaces_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [Workspaces](#API_DescribeWorkspaces_ResponseSyntax) ** Information about the WorkSpaces. Because [CreateWorkspaces](API_CreateWorkspaces.md) is an asynchronous operation, some of the returned information could be incomplete. Type: Array of [Workspace](API_Workspace.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceUnavailableException ** The specified resource is not available. ** message ** The exception error message. ** ResourceId ** The identifier of the resource that is not available. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspaces) # DescribeWorkspacesConnectionStatus Describes the connection status of the specified WorkSpaces. ## Request Syntax ``` { "NextToken": "string", "WorkspaceIds": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [NextToken](#API_DescribeWorkspacesConnectionStatus_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [WorkspaceIds](#API_DescribeWorkspacesConnectionStatus_RequestSyntax) ** The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: `^ws-[0-9a-z]{8,63}$` Required: No ## Response Syntax ``` { "NextToken": "string", "WorkspacesConnectionStatus": [ { "ConnectionState": "string", "ConnectionStateCheckTimestamp": number, "LastKnownUserConnectionTimestamp": number, "WorkspaceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribeWorkspacesConnectionStatus_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [WorkspacesConnectionStatus](#API_DescribeWorkspacesConnectionStatus_ResponseSyntax) ** Information about the connection status of the WorkSpace. Type: Array of [WorkspaceConnectionStatus](API_WorkspaceConnectionStatus.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspacesConnectionStatus) # DescribeWorkspaceSnapshots Describes the snapshots for the specified WorkSpace. ## Request Syntax ``` { "WorkspaceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WorkspaceId](#API_DescribeWorkspaceSnapshots_RequestSyntax) ** The identifier of the WorkSpace. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ## Response Syntax ``` { "RebuildSnapshots": [ { "SnapshotTime": number } ], "RestoreSnapshots": [ { "SnapshotTime": number } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [RebuildSnapshots](#API_DescribeWorkspaceSnapshots_ResponseSyntax) ** Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume. Type: Array of [Snapshot](API_Snapshot.md) objects ** [RestoreSnapshots](#API_DescribeWorkspaceSnapshots_ResponseSyntax) ** Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume. Type: Array of [Snapshot](API_Snapshot.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspaceSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspaceSnapshots) # DescribeWorkspacesPools Describes the specified WorkSpaces Pools. ## Request Syntax ``` { "Filters": [ { "Name": "string", "Operator": "string", "Values": [ "string" ] } ], "Limit": number, "NextToken": "string", "PoolIds": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Filters](#API_DescribeWorkspacesPools_RequestSyntax) ** The filter conditions for the WorkSpaces Pool to return. Type: Array of [DescribeWorkspacesPoolsFilter](API_DescribeWorkspacesPoolsFilter.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: No ** [Limit](#API_DescribeWorkspacesPools_RequestSyntax) ** The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_DescribeWorkspacesPools_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PoolIds](#API_DescribeWorkspacesPools_RequestSyntax) ** The identifier of the WorkSpaces Pools. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 25 items. Pattern: `^wspool-[0-9a-z]{9}$` Required: No ## Response Syntax ``` { "NextToken": "string", "WorkspacesPools": [ { "ApplicationSettings": { "S3BucketName": "string", "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "CapacityStatus": { "ActiveUserSessions": number, "ActualUserSessions": number, "AvailableUserSessions": number, "DesiredUserSessions": number }, "CreatedAt": number, "Description": "string", "DirectoryId": "string", "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "PoolArn": "string", "PoolId": "string", "PoolName": "string", "RunningMode": "string", "State": "string", "TimeoutSettings": { "DisconnectTimeoutInSeconds": number, "IdleDisconnectTimeoutInSeconds": number, "MaxUserDurationInSeconds": number } } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribeWorkspacesPools_ResponseSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [WorkspacesPools](#API_DescribeWorkspacesPools_ResponseSyntax) ** Information about the WorkSpaces Pools. Type: Array of [WorkspacesPool](API_WorkspacesPool.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspacesPools) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspacesPools) # DescribeWorkspacesPoolSessions Retrieves a list that describes the streaming sessions for a specified pool. ## Request Syntax ``` { "Limit": number, "NextToken": "string", "PoolId": "string", "UserId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Limit](#API_DescribeWorkspacesPoolSessions_RequestSyntax) ** The maximum size of each page of results. The default value is 20 and the maximum value is 50. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ** [NextToken](#API_DescribeWorkspacesPoolSessions_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ** [PoolId](#API_DescribeWorkspacesPoolSessions_RequestSyntax) ** The identifier of the pool. Type: String Pattern: `^wspool-[0-9a-z]{9}$` Required: Yes ** [UserId](#API_DescribeWorkspacesPoolSessions_RequestSyntax) ** The identifier of the user. Type: String Length Constraints: Minimum length of 2. Maximum length of 128. Required: No ## Response Syntax ``` { "NextToken": "string", "Sessions": [ { "AuthenticationType": "string", "ConnectionState": "string", "ExpirationTime": number, "InstanceId": "string", "NetworkAccessConfiguration": { "EniId": "string", "EniPrivateIpAddress": "string" }, "PoolId": "string", "SessionId": "string", "StartTime": number, "UserId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [NextToken](#API_DescribeWorkspacesPoolSessions_ResponseSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ** [Sessions](#API_DescribeWorkspacesPoolSessions_ResponseSyntax) ** Describes the pool sessions. Type: Array of [WorkspacesPoolSession](API_WorkspacesPoolSession.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DescribeWorkspacesPoolSessions) # DisassociateConnectionAlias 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). **Note** Before performing this operation, call [ DescribeConnectionAliases](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) to make sure that the current state of the connection alias is `CREATED`. ## Request Syntax ``` { "AliasId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AliasId](#API_DisassociateConnectionAlias_RequestSyntax) ** The identifier of the connection alias to disassociate. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: `^wsca-[0-9a-z]{8,63}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DisassociateConnectionAlias) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DisassociateConnectionAlias) # DisassociateIpGroups Disassociates the specified IP access control group from the specified directory. ## Request Syntax ``` { "DirectoryId": "string", "GroupIds": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DirectoryId](#API_DisassociateIpGroups_RequestSyntax) ** The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [GroupIds](#API_DisassociateIpGroups_RequestSyntax) ** The identifiers of one or more IP access control groups. Type: Array of strings Pattern: `wsipg-[0-9a-z]{8,63}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DisassociateIpGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DisassociateIpGroups) # DisassociateWorkspaceApplication Disassociates the specified application from a WorkSpace. ## Request Syntax ``` { "ApplicationId": "string", "WorkspaceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationId](#API_DisassociateWorkspaceApplication_RequestSyntax) ** The identifier of the application. Type: String Pattern: `^wsa-[0-9a-z]{8,63}$` Required: Yes ** [WorkspaceId](#API_DisassociateWorkspaceApplication_RequestSyntax) ** The identifier of the WorkSpace. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ## Response Syntax ``` { "Association": { "AssociatedResourceId": "string", "AssociatedResourceType": "string", "Created": number, "LastUpdatedTime": number, "State": "string", "StateReason": { "ErrorCode": "string", "ErrorMessage": "string" }, "WorkspaceId": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Association](#API_DisassociateWorkspaceApplication_ResponseSyntax) ** Information about the targeted association. Type: [WorkspaceResourceAssociation](API_WorkspaceResourceAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceInUseException ** The specified resource is currently in use. ** ResourceId ** The ID of the resource that is in use. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/DisassociateWorkspaceApplication) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/DisassociateWorkspaceApplication) # GetAccountLink Retrieves account link information. ## Request Syntax ``` { "LinkedAccountId": "string", "LinkId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [LinkedAccountId](#API_GetAccountLink_RequestSyntax) ** The identifier of the account link Type: String Pattern: `^\d{12}$` Required: No ** [LinkId](#API_GetAccountLink_RequestSyntax) ** The identifier of the account to link. Type: String Pattern: `^link-.{8,24}$` Required: No ## Response Syntax ``` { "AccountLink": { "AccountLinkId": "string", "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AccountLink](#API_GetAccountLink_ResponseSyntax) ** The account link of the account link to retrieve. Type: [AccountLink](API_AccountLink.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InternalServerException ** Unexpected server error occured. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ValidationException ** You either haven't provided a `TargetAccountId` or are using the same value for `TargetAccountId` and `SourceAccountId`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/GetAccountLink) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/GetAccountLink) # ImportClientBranding 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 **Note** 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. ## Request Syntax ``` { "DeviceTypeAndroid": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeIos": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "Logo2x": blob, "Logo3x": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeLinux": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeOsx": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWeb": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWindows": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo": blob, "SupportEmail": "string", "SupportLink": "string" }, "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DeviceTypeAndroid](#API_ImportClientBranding_RequestSyntax) ** The branding information to import for Android devices. Type: [DefaultImportClientBrandingAttributes](API_DefaultImportClientBrandingAttributes.md) object Required: No ** [DeviceTypeIos](#API_ImportClientBranding_RequestSyntax) ** The branding information to import for iOS devices. Type: [IosImportClientBrandingAttributes](API_IosImportClientBrandingAttributes.md) object Required: No ** [DeviceTypeLinux](#API_ImportClientBranding_RequestSyntax) ** The branding information to import for Linux devices. Type: [DefaultImportClientBrandingAttributes](API_DefaultImportClientBrandingAttributes.md) object Required: No ** [DeviceTypeOsx](#API_ImportClientBranding_RequestSyntax) ** The branding information to import for macOS devices. Type: [DefaultImportClientBrandingAttributes](API_DefaultImportClientBrandingAttributes.md) object Required: No ** [DeviceTypeWeb](#API_ImportClientBranding_RequestSyntax) ** The branding information to import for web access. Type: [DefaultImportClientBrandingAttributes](API_DefaultImportClientBrandingAttributes.md) object Required: No ** [DeviceTypeWindows](#API_ImportClientBranding_RequestSyntax) ** The branding information to import for Windows devices. Type: [DefaultImportClientBrandingAttributes](API_DefaultImportClientBrandingAttributes.md) object Required: No ** [ResourceId](#API_ImportClientBranding_RequestSyntax) ** The directory identifier of the WorkSpace for which you want to import client branding. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ## Response Syntax ``` { "DeviceTypeAndroid": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeIos": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "Logo2xUrl": "string", "Logo3xUrl": "string", "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeLinux": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeOsx": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWeb": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" }, "DeviceTypeWindows": { "ForgotPasswordLink": "string", "LoginMessage": { "string" : "string" }, "LogoUrl": "string", "SupportEmail": "string", "SupportLink": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DeviceTypeAndroid](#API_ImportClientBranding_ResponseSyntax) ** The branding information configured for Android devices. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ** [DeviceTypeIos](#API_ImportClientBranding_ResponseSyntax) ** The branding information configured for iOS devices. Type: [IosClientBrandingAttributes](API_IosClientBrandingAttributes.md) object ** [DeviceTypeLinux](#API_ImportClientBranding_ResponseSyntax) ** The branding information configured for Linux devices. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ** [DeviceTypeOsx](#API_ImportClientBranding_ResponseSyntax) ** The branding information configured for macOS devices. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ** [DeviceTypeWeb](#API_ImportClientBranding_ResponseSyntax) ** The branding information configured for web access. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ** [DeviceTypeWindows](#API_ImportClientBranding_ResponseSyntax) ** The branding information configured for Windows devices. Type: [DefaultClientBrandingAttributes](API_DefaultClientBrandingAttributes.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ImportClientBranding) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ImportClientBranding) # ImportCustomWorkspaceImage Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see [ Bring Your Own Windows Desktop Licenses](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). ## Request Syntax ``` { "ComputeType": "string", "ImageDescription": "string", "ImageName": "string", "ImageSource": { ... }, "InfrastructureConfigurationArn": "string", "OsVersion": "string", "Platform": "string", "Protocol": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ComputeType](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The supported compute type for the WorkSpace image. Type: String Valid Values: `BASE | GRAPHICS_G4DN | GRAPHICS_G6` Required: Yes ** [ImageDescription](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The description of the WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9_./() -]+$` Required: Yes ** [ImageName](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The name of the WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_./()\\-]+$` Required: Yes ** [ImageSource](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The options for image import source. Type: [ImageSourceIdentifier](API_ImageSourceIdentifier.md) object **Note: **This object is a Union. Only one member of this object can be specified or returned. Required: Yes ** [InfrastructureConfigurationArn](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The infrastructure configuration ARN that specifies how the WorkSpace image is built. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$` Required: Yes ** [OsVersion](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The OS version for the WorkSpace image source. Type: String Valid Values: `Windows_10 | Windows_11` Required: Yes ** [Platform](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The platform for the WorkSpace image source. Type: String Valid Values: `WINDOWS` Required: Yes ** [Protocol](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol. Type: String Valid Values: `PCOIP | DCV | BYOP` Required: Yes ** [Tags](#API_ImportCustomWorkspaceImage_RequestSyntax) ** The resource tags. Each WorkSpaces resource can have a maximum of 50 tags. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` { "ImageId": "string", "State": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageId](#API_ImportCustomWorkspaceImage_ResponseSyntax) ** The identifier of the WorkSpace image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` ** [State](#API_ImportCustomWorkspaceImage_ResponseSyntax) ** The state of the WorkSpace image. Type: String Valid Values: `PENDING | IN_PROGRESS | PROCESSING_SOURCE_IMAGE | IMAGE_TESTING_START | UPDATING_OPERATING_SYSTEM | IMAGE_COMPATIBILITY_CHECKING | IMAGE_TESTING_GENERALIZATION | CREATING_TEST_INSTANCE | INSTALLING_COMPONENTS | GENERALIZING | VALIDATING | PUBLISHING | COMPLETED | ERROR` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ImportCustomWorkspaceImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ImportCustomWorkspaceImage) # ImportWorkspaceImage Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see [ Bring Your Own Windows Desktop Licenses](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). ## Request Syntax ``` { "Applications": [ "string" ], "Ec2ImageId": "string", "ImageDescription": "string", "ImageName": "string", "IngestionProcess": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [Applications](#API_ImportWorkspaceImage_RequestSyntax) ** 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). + Although this parameter is an array, only one item is allowed at this time. + During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only `Microsoft_Office_2019`. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Valid Values: `Microsoft_Office_2016 | Microsoft_Office_2019` Required: No ** [Ec2ImageId](#API_ImportWorkspaceImage_RequestSyntax) ** The identifier of the EC2 image. Type: String Pattern: `^ami\-([a-f0-9]{8}|[a-f0-9]{17})$` Required: Yes ** [ImageDescription](#API_ImportWorkspaceImage_RequestSyntax) ** The description of the WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: `^[a-zA-Z0-9_./() -]+$` Required: Yes ** [ImageName](#API_ImportWorkspaceImage_RequestSyntax) ** The name of the WorkSpace image. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^[a-zA-Z0-9_./()\\-]+$` Required: Yes ** [IngestionProcess](#API_ImportWorkspaceImage_RequestSyntax) ** 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, WSP, or bring your own protocol (BYOP). To use DCV, 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](http://aws.amazon.com/workspaces/core/). Type: String Valid Values: `BYOL_REGULAR | BYOL_GRAPHICS | BYOL_GRAPHICSPRO | BYOL_GRAPHICS_G4DN | BYOL_REGULAR_WSP | BYOL_GRAPHICS_G4DN_WSP | BYOL_REGULAR_BYOP | BYOL_GRAPHICS_G4DN_BYOP` Required: Yes ** [Tags](#API_ImportWorkspaceImage_RequestSyntax) ** The tags. Each WorkSpaces resource can have a maximum of 50 tags. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Syntax ``` { "ImageId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ImageId](#API_ImportWorkspaceImage_ResponseSyntax) ** The identifier of the WorkSpace image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ImportWorkspaceImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ImportWorkspaceImage) # ListAccountLinks Lists all account links. ## Request Syntax ``` { "LinkStatusFilter": [ "string" ], "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [LinkStatusFilter](#API_ListAccountLinks_RequestSyntax) ** Filters the account based on their link status. Type: Array of strings Valid Values: `LINKED | LINKING_FAILED | LINK_NOT_FOUND | PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT | REJECTED` Required: No ** [MaxResults](#API_ListAccountLinks_RequestSyntax) ** The maximum number of accounts to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 25. Required: No ** [NextToken](#API_ListAccountLinks_RequestSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ## Response Syntax ``` { "AccountLinks": [ { "AccountLinkId": "string", "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "string" } ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AccountLinks](#API_ListAccountLinks_ResponseSyntax) ** Information about the account links. Type: Array of [AccountLink](API_AccountLink.md) objects ** [NextToken](#API_ListAccountLinks_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InternalServerException ** Unexpected server error occured. HTTP Status Code: 400 ** ValidationException ** You either haven't provided a `TargetAccountId` or are using the same value for `TargetAccountId` and `SourceAccountId`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ListAccountLinks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ListAccountLinks) # ListAvailableManagementCidrRanges 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 AWS 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. ## Request Syntax ``` { "ManagementCidrRangeConstraint": "string", "MaxResults": number, "NextToken": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ManagementCidrRangeConstraint](#API_ListAvailableManagementCidrRanges_RequestSyntax) ** The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). Type: String Pattern: `^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/(3[0-2]|[1-2][0-9]|[0-9]))$` Required: Yes ** [MaxResults](#API_ListAvailableManagementCidrRanges_RequestSyntax) ** The maximum number of items to return. Type: Integer Valid Range: Minimum value of 1. Maximum value of 5. Required: No ** [NextToken](#API_ListAvailableManagementCidrRanges_RequestSyntax) ** If you received a `NextToken` from a previous call that was paginated, provide this token to receive the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ## Response Syntax ``` { "ManagementCidrRanges": [ "string" ], "NextToken": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [ManagementCidrRanges](#API_ListAvailableManagementCidrRanges_ResponseSyntax) ** The list of available IP address ranges, specified as IPv4 CIDR blocks. Type: Array of strings Pattern: `(^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.0\.0)(\/(16$))$` ** [NextToken](#API_ListAvailableManagementCidrRanges_ResponseSyntax) ** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ListAvailableManagementCidrRanges) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ListAvailableManagementCidrRanges) # MigrateWorkspace 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/migrate-workspaces.html). ## Request Syntax ``` { "BundleId": "string", "SourceWorkspaceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [BundleId](#API_MigrateWorkspace_RequestSyntax) ** The identifier of the target bundle type to migrate the WorkSpace to. Type: String Pattern: `^wsb-[0-9a-z]{8,63}$` Required: Yes ** [SourceWorkspaceId](#API_MigrateWorkspace_RequestSyntax) ** The identifier of the WorkSpace to migrate from. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ## Response Syntax ``` { "SourceWorkspaceId": "string", "TargetWorkspaceId": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [SourceWorkspaceId](#API_MigrateWorkspace_ResponseSyntax) ** The original identifier of the WorkSpace that is being migrated. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` ** [TargetWorkspaceId](#API_MigrateWorkspace_ResponseSyntax) ** 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. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationInProgressException ** The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ResourceUnavailableException ** The specified resource is not available. ** message ** The exception error message. ** ResourceId ** The identifier of the resource that is not available. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/MigrateWorkspace) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/MigrateWorkspace) # ModifyAccount Modifies the configuration of Bring Your Own License (BYOL) for the specified account. ## Request Syntax ``` { "DedicatedTenancyManagementCidrRange": "string", "DedicatedTenancySupport": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DedicatedTenancyManagementCidrRange](#API_ModifyAccount_RequestSyntax) ** 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. Type: String Pattern: `(^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.0\.0)(\/(16$))$` Required: No ** [DedicatedTenancySupport](#API_ModifyAccount_RequestSyntax) ** The status of BYOL. Type: String Valid Values: `ENABLED` Required: No ## Response Syntax ``` { "Message": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [Message](#API_ModifyAccount_ResponseSyntax) ** The text message to describe the status of BYOL modification. Type: String ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ResourceUnavailableException ** The specified resource is not available. ** message ** The exception error message. ** ResourceId ** The identifier of the resource that is not available. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyAccount) # ModifyCertificateBasedAuthProperties Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces. ## Request Syntax ``` { "CertificateBasedAuthProperties": { "CertificateAuthorityArn": "string", "Status": "string" }, "PropertiesToDelete": [ "string" ], "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [CertificateBasedAuthProperties](#API_ModifyCertificateBasedAuthProperties_RequestSyntax) ** The properties of the certificate-based authentication. Type: [CertificateBasedAuthProperties](API_CertificateBasedAuthProperties.md) object Required: No ** [PropertiesToDelete](#API_ModifyCertificateBasedAuthProperties_RequestSyntax) ** The properties of the certificate-based authentication you want to delete. Type: Array of strings Valid Values: `CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN` Required: No ** [ResourceId](#API_ModifyCertificateBasedAuthProperties_RequestSyntax) ** The resource identifiers, in the form of directory IDs. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyCertificateBasedAuthProperties) # ModifyClientProperties Modifies the properties of the specified Amazon WorkSpaces clients. ## Request Syntax ``` { "ClientProperties": { "LogUploadEnabled": "string", "ReconnectEnabled": "string" }, "ResourceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ClientProperties](#API_ModifyClientProperties_RequestSyntax) ** Information about the Amazon WorkSpaces client. Type: [ClientProperties](API_ClientProperties.md) object Required: Yes ** [ResourceId](#API_ModifyClientProperties_RequestSyntax) ** The resource identifiers, in the form of directory IDs. Type: String Length Constraints: Minimum length of 1. Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyClientProperties) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyClientProperties) # ModifyEndpointEncryptionMode Modifies the endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode. ## Request Syntax ``` { "DirectoryId": "string", "EndpointEncryptionMode": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DirectoryId](#API_ModifyEndpointEncryptionMode_RequestSyntax) ** The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [EndpointEncryptionMode](#API_ModifyEndpointEncryptionMode_RequestSyntax) ** The encryption mode used for endpoint connections when streaming to WorkSpaces Personal or WorkSpace Pools. Type: String Valid Values: `STANDARD_TLS | FIPS_VALIDATED` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyEndpointEncryptionMode) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyEndpointEncryptionMode) # ModifySamlProperties 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. ## Request Syntax ``` { "PropertiesToDelete": [ "string" ], "ResourceId": "string", "SamlProperties": { "RelayStateParameterName": "string", "Status": "string", "UserAccessUrl": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PropertiesToDelete](#API_ModifySamlProperties_RequestSyntax) ** 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. Type: Array of strings Valid Values: `SAML_PROPERTIES_USER_ACCESS_URL | SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME` Required: No ** [ResourceId](#API_ModifySamlProperties_RequestSyntax) ** The directory identifier for which you want to configure SAML properties. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [SamlProperties](#API_ModifySamlProperties_RequestSyntax) ** The properties for configuring SAML 2.0 authentication. Type: [SamlProperties](API_SamlProperties.md) object Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifySamlProperties) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifySamlProperties) # ModifySelfservicePermissions Modifies the self-service WorkSpace management capabilities for your users. For more information, see [Enable Self-Service WorkSpace Management Capabilities for Your Users](https://docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html). ## Request Syntax ``` { "ResourceId": "string", "SelfservicePermissions": { "ChangeComputeType": "string", "IncreaseVolumeSize": "string", "RebuildWorkspace": "string", "RestartWorkspace": "string", "SwitchRunningMode": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceId](#API_ModifySelfservicePermissions_RequestSyntax) ** The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [SelfservicePermissions](#API_ModifySelfservicePermissions_RequestSyntax) ** The permissions to enable or disable self-service capabilities. Type: [SelfservicePermissions](API_SelfservicePermissions.md) object Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifySelfservicePermissions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifySelfservicePermissions) # ModifyStreamingProperties Modifies the specified streaming properties. ## Request Syntax ``` { "ResourceId": "string", "StreamingProperties": { "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "StorageConnectors": [ { "ConnectorType": "string", "Status": "string" } ], "StreamingExperiencePreferredProtocol": "string", "UserSettings": [ { "Action": "string", "MaximumLength": number, "Permission": "string" } ] } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceId](#API_ModifyStreamingProperties_RequestSyntax) ** The identifier of the resource. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [StreamingProperties](#API_ModifyStreamingProperties_RequestSyntax) ** The streaming properties to configure. Type: [StreamingProperties](API_StreamingProperties.md) object Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyStreamingProperties) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyStreamingProperties) # ModifyWorkspaceAccessProperties Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see [ Control Device Access](https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#control-device-access). ## Request Syntax ``` { "ResourceId": "string", "WorkspaceAccessProperties": { "AccessEndpointConfig": { "AccessEndpoints": [ { "AccessEndpointType": "string", "VpcEndpointId": "string" } ], "InternetFallbackProtocols": [ "string" ] }, "DeviceTypeAndroid": "string", "DeviceTypeChromeOs": "string", "DeviceTypeIos": "string", "DeviceTypeLinux": "string", "DeviceTypeOsx": "string", "DeviceTypeWeb": "string", "DeviceTypeWindows": "string", "DeviceTypeWorkSpacesThinClient": "string", "DeviceTypeZeroClient": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceId](#API_ModifyWorkspaceAccessProperties_RequestSyntax) ** The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [WorkspaceAccessProperties](#API_ModifyWorkspaceAccessProperties_RequestSyntax) ** The device types and operating systems to enable or disable for access. Type: [WorkspaceAccessProperties](API_WorkspaceAccessProperties.md) object Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterCombinationException ** Two or more of the selected parameter values cannot be used together. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyWorkspaceAccessProperties) # ModifyWorkspaceCreationProperties Modify the default properties used to create WorkSpaces. ## Request Syntax ``` { "ResourceId": "string", "WorkspaceCreationProperties": { "CustomSecurityGroupId": "string", "DefaultOu": "string", "EnableInternetAccess": boolean, "EnableMaintenanceMode": boolean, "InstanceIamRoleArn": "string", "UserEnabledAsLocalAdministrator": boolean } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ResourceId](#API_ModifyWorkspaceCreationProperties_RequestSyntax) ** The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [WorkspaceCreationProperties](#API_ModifyWorkspaceCreationProperties_RequestSyntax) ** The default properties for creating WorkSpaces. Type: [WorkspaceCreationProperties](API_WorkspaceCreationProperties.md) object Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyWorkspaceCreationProperties) # ModifyWorkspaceProperties Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see [ Modify a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html). **Note** 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](http://aws.amazon.com/workspaces/core/). ## Request Syntax ``` { "DataReplication": "string", "WorkspaceId": "string", "WorkspaceProperties": { "ComputeTypeName": "string", "GlobalAccelerator": { "Mode": "string", "PreferredProtocol": "string" }, "OperatingSystemName": "string", "Protocols": [ "string" ], "RootVolumeSizeGib": number, "RunningMode": "string", "RunningModeAutoStopTimeoutInMinutes": number, "UserVolumeSizeGib": number } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [DataReplication](#API_ModifyWorkspaceProperties_RequestSyntax) ** Indicates the data replication status. Type: String Valid Values: `NO_REPLICATION | PRIMARY_AS_SOURCE` Required: No ** [WorkspaceId](#API_ModifyWorkspaceProperties_RequestSyntax) ** The identifier of the WorkSpace. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ** [WorkspaceProperties](#API_ModifyWorkspaceProperties_RequestSyntax) ** The properties of the WorkSpace. Type: [WorkspaceProperties](API_WorkspaceProperties.md) object Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationInProgressException ** The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ResourceUnavailableException ** The specified resource is not available. ** message ** The exception error message. ** ResourceId ** The identifier of the resource that is not available. HTTP Status Code: 400 ** UnsupportedWorkspaceConfigurationException ** The configuration of this WorkSpace is not supported for this operation. For more information, see [Required Configuration and Service Components for WorkSpaces ](https://docs.aws.amazon.com/workspaces/latest/adminguide/required-service-components.html). HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyWorkspaceProperties) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyWorkspaceProperties) # ModifyWorkspaceState 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. ## Request Syntax ``` { "WorkspaceId": "string", "WorkspaceState": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WorkspaceId](#API_ModifyWorkspaceState_RequestSyntax) ** The identifier of the WorkSpace. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ** [WorkspaceState](#API_ModifyWorkspaceState_RequestSyntax) ** The WorkSpace state. Type: String Valid Values: `AVAILABLE | ADMIN_MAINTENANCE` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/ModifyWorkspaceState) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/ModifyWorkspaceState) # RebootWorkspaces Reboots the specified WorkSpaces. You cannot reboot a WorkSpace unless its state is `AVAILABLE`, `UNHEALTHY`, or `REBOOTING`. Reboot a WorkSpace in the `REBOOTING` state only if your WorkSpace has been stuck in the `REBOOTING` state for over 20 minutes. This operation is asynchronous and returns before the WorkSpaces have rebooted. ## Request Syntax ``` { "RebootWorkspaceRequests": [ { "WorkspaceId": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [RebootWorkspaceRequests](#API_RebootWorkspaces_RequestSyntax) ** The WorkSpaces to reboot. You can specify up to 25 WorkSpaces. Type: Array of [RebootRequest](API_RebootRequest.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes ## Response Syntax ``` { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FailedRequests](#API_RebootWorkspaces_ResponseSyntax) ** Information about the WorkSpaces that could not be rebooted. Type: Array of [FailedWorkspaceChangeRequest](API_FailedWorkspaceChangeRequest.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/RebootWorkspaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/RebootWorkspaces) # RebuildWorkspaces 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html). This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt. ## Request Syntax ``` { "RebuildWorkspaceRequests": [ { "WorkspaceId": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [RebuildWorkspaceRequests](#API_RebuildWorkspaces_RequestSyntax) ** The WorkSpace to rebuild. You can specify a single WorkSpace. Type: Array of [RebuildRequest](API_RebuildRequest.md) objects Array Members: Fixed number of 1 item. Required: Yes ## Response Syntax ``` { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FailedRequests](#API_RebuildWorkspaces_ResponseSyntax) ** Information about the WorkSpace that could not be rebuilt. Type: Array of [FailedWorkspaceChangeRequest](API_FailedWorkspaceChangeRequest.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/RebuildWorkspaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/RebuildWorkspaces) # RegisterWorkspaceDirectory 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\$1DefaultRole role before you can register a directory. For more information, see [ Creating the workspaces\$1DefaultRole Role](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role). ## Request Syntax ``` { "ActiveDirectoryConfig": { "DomainName": "string", "ServiceAccountSecretArn": "string" }, "DirectoryId": "string", "EnableSelfService": boolean, "IdcInstanceArn": "string", "MicrosoftEntraConfig": { "ApplicationConfigSecretArn": "string", "TenantId": "string" }, "SubnetIds": [ "string" ], "Tags": [ { "Key": "string", "Value": "string" } ], "Tenancy": "string", "UserIdentityType": "string", "WorkspaceDirectoryDescription": "string", "WorkspaceDirectoryName": "string", "WorkspaceType": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ActiveDirectoryConfig](#API_RegisterWorkspaceDirectory_RequestSyntax) ** The active directory config of the directory. Type: [ActiveDirectoryConfig](API_ActiveDirectoryConfig.md) object Required: No ** [DirectoryId](#API_RegisterWorkspaceDirectory_RequestSyntax) ** The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: No ** [EnableSelfService](#API_RegisterWorkspaceDirectory_RequestSyntax) ** Indicates whether self-service capabilities are enabled or disabled. Type: Boolean Required: No ** [IdcInstanceArn](#API_RegisterWorkspaceDirectory_RequestSyntax) ** The Amazon Resource Name (ARN) of the identity center instance. Type: String Pattern: `^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$` Required: No ** [MicrosoftEntraConfig](#API_RegisterWorkspaceDirectory_RequestSyntax) ** The details about Microsoft Entra config. Type: [MicrosoftEntraConfig](API_MicrosoftEntraConfig.md) object Required: No ** [SubnetIds](#API_RegisterWorkspaceDirectory_RequestSyntax) ** The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error. Type: Array of strings Array Members: Maximum number of 2 items. Length Constraints: Minimum length of 15. Maximum length of 24. Pattern: `^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$` Required: No ** [Tags](#API_RegisterWorkspaceDirectory_RequestSyntax) ** The tags associated with the directory. Type: Array of [Tag](API_Tag.md) objects Required: No ** [Tenancy](#API_RegisterWorkspaceDirectory_RequestSyntax) ** 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 AWS 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). Type: String Valid Values: `DEDICATED | SHARED` Required: No ** [UserIdentityType](#API_RegisterWorkspaceDirectory_RequestSyntax) ** The type of identity management the user is using. Type: String Valid Values: `CUSTOMER_MANAGED | AWS_DIRECTORY_SERVICE | AWS_IAM_IDENTITY_CENTER` Required: No ** [WorkspaceDirectoryDescription](#API_RegisterWorkspaceDirectory_RequestSyntax) ** Description of the directory to register. Type: String Pattern: `^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]{1,255}$` Required: No ** [WorkspaceDirectoryName](#API_RegisterWorkspaceDirectory_RequestSyntax) ** The name of the directory to register. Type: String Pattern: `^[a-zA-Z0-9][a-zA-Z0-9_.\s-]{1,64}$` Required: No ** [WorkspaceType](#API_RegisterWorkspaceDirectory_RequestSyntax) ** Indicates whether the directory's WorkSpace type is personal or pools. Type: String Valid Values: `PERSONAL | POOLS` Required: No ## Response Syntax ``` { "DirectoryId": "string", "State": "string" } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [DirectoryId](#API_RegisterWorkspaceDirectory_ResponseSyntax) ** The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` ** [State](#API_RegisterWorkspaceDirectory_ResponseSyntax) ** The registration status of the WorkSpace directory. Type: String Valid Values: `REGISTERING | REGISTERED | DEREGISTERING | DEREGISTERED | ERROR` ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAlreadyExistsException ** The specified resource already exists. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** UnsupportedNetworkConfigurationException ** The configuration of this network is not supported for this operation, or your network configuration conflicts with the Amazon WorkSpaces management network IP range. For more information, see [ Configure a VPC for Amazon WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html). HTTP Status Code: 400 ** WorkspacesDefaultRoleNotFoundException ** The workspaces\$1DefaultRole role could not be found. If this is the first time you are registering a directory, you will need to create the workspaces\$1DefaultRole role before you can register a directory. For more information, see [Creating the workspaces\$1DefaultRole Role](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role). HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/RegisterWorkspaceDirectory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/RegisterWorkspaceDirectory) # RejectAccountLinkInvitation Rejects the account link invitation. ## Request Syntax ``` { "ClientToken": "string", "LinkId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ClientToken](#API_RejectAccountLinkInvitation_RequestSyntax) ** The client token of the account link invitation to reject. Type: String Pattern: `^.{1,64}$` Required: No ** [LinkId](#API_RejectAccountLinkInvitation_RequestSyntax) ** The identifier of the account link Type: String Pattern: `^link-.{8,24}$` Required: Yes ## Response Syntax ``` { "AccountLink": { "AccountLinkId": "string", "AccountLinkStatus": "string", "SourceAccountId": "string", "TargetAccountId": "string" } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [AccountLink](#API_RejectAccountLinkInvitation_ResponseSyntax) ** Information about the account link. Type: [AccountLink](API_AccountLink.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** ConflictException ** The `TargetAccountId` is already linked or invited. HTTP Status Code: 400 ** InternalServerException ** Unexpected server error occured. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ValidationException ** You either haven't provided a `TargetAccountId` or are using the same value for `TargetAccountId` and `SourceAccountId`. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/RejectAccountLinkInvitation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/RejectAccountLinkInvitation) # RestoreWorkspace 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html). This operation is asynchronous and returns before the WorkSpace is completely restored. ## Request Syntax ``` { "WorkspaceId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [WorkspaceId](#API_RestoreWorkspace_RequestSyntax) ** The identifier of the WorkSpace. Type: String Pattern: `^ws-[0-9a-z]{8,63}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/RestoreWorkspace) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/RestoreWorkspace) # RevokeIpRules Removes one or more rules from the specified IP access control group. ## Request Syntax ``` { "GroupId": "string", "UserRules": [ "string" ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [GroupId](#API_RevokeIpRules_RequestSyntax) ** The identifier of the group. Type: String Pattern: `wsipg-[0-9a-z]{8,63}$` Required: Yes ** [UserRules](#API_RevokeIpRules_RequestSyntax) ** The rules to remove from the group. Type: Array of strings Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/RevokeIpRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/RevokeIpRules) # StartWorkspaces Starts the specified WorkSpaces. You cannot start a WorkSpace unless it has a running mode of `AutoStop` or `Manual` and a state of `STOPPED`. ## Request Syntax ``` { "StartWorkspaceRequests": [ { "WorkspaceId": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [StartWorkspaceRequests](#API_StartWorkspaces_RequestSyntax) ** The WorkSpaces to start. You can specify up to 25 WorkSpaces. Type: Array of [StartRequest](API_StartRequest.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes ## Response Syntax ``` { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FailedRequests](#API_StartWorkspaces_ResponseSyntax) ** Information about the WorkSpaces that could not be started. Type: Array of [FailedWorkspaceChangeRequest](API_FailedWorkspaceChangeRequest.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/StartWorkspaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/StartWorkspaces) # StartWorkspacesPool Starts the specified pool. You cannot start a pool unless it has a running mode of `AutoStop` and a state of `STOPPED`. ## Request Syntax ``` { "PoolId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PoolId](#API_StartWorkspacesPool_RequestSyntax) ** The identifier of the pool. Type: String Pattern: `^wspool-[0-9a-z]{9}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationInProgressException ** The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/StartWorkspacesPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/StartWorkspacesPool) # StopWorkspaces Stops the specified WorkSpaces. You cannot stop a WorkSpace unless it has a running mode of `AutoStop` or `Manual` and a state of `AVAILABLE`, `IMPAIRED`, `UNHEALTHY`, or `ERROR`. ## Request Syntax ``` { "StopWorkspaceRequests": [ { "WorkspaceId": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [StopWorkspaceRequests](#API_StopWorkspaces_RequestSyntax) ** The WorkSpaces to stop. You can specify up to 25 WorkSpaces. Type: Array of [StopRequest](API_StopRequest.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes ## Response Syntax ``` { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FailedRequests](#API_StopWorkspaces_ResponseSyntax) ** Information about the WorkSpaces that could not be stopped. Type: Array of [FailedWorkspaceChangeRequest](API_FailedWorkspaceChangeRequest.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/StopWorkspaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/StopWorkspaces) # StopWorkspacesPool Stops the specified pool. You cannot stop a WorkSpace pool unless it has a running mode of `AutoStop` and a state of `AVAILABLE`, `IMPAIRED`, `UNHEALTHY`, or `ERROR`. ## Request Syntax ``` { "PoolId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PoolId](#API_StopWorkspacesPool_RequestSyntax) ** The identifier of the pool. Type: String Pattern: `^wspool-[0-9a-z]{9}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationInProgressException ** The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/StopWorkspacesPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/StopWorkspacesPool) # TerminateWorkspaces Terminates the specified WorkSpaces. **Important** 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 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](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html). If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated. **Note** 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](http://aws.amazon.com/directoryservice/pricing/). To delete empty directories, see [ Delete the Directory for Your WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html). 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. ## Request Syntax ``` { "TerminateWorkspaceRequests": [ { "WorkspaceId": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [TerminateWorkspaceRequests](#API_TerminateWorkspaces_RequestSyntax) ** The WorkSpaces to terminate. You can specify up to 25 WorkSpaces. Type: Array of [TerminateRequest](API_TerminateRequest.md) objects Array Members: Minimum number of 1 item. Maximum number of 25 items. Required: Yes ## Response Syntax ``` { "FailedRequests": [ { "ErrorCode": "string", "ErrorMessage": "string", "WorkspaceId": "string" } ] } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [FailedRequests](#API_TerminateWorkspaces_ResponseSyntax) ** Information about the WorkSpaces that could not be terminated. Type: Array of [FailedWorkspaceChangeRequest](API_FailedWorkspaceChangeRequest.md) objects ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/TerminateWorkspaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/TerminateWorkspaces) # TerminateWorkspacesPool Terminates the specified pool. ## Request Syntax ``` { "PoolId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [PoolId](#API_TerminateWorkspacesPool_RequestSyntax) ** The identifier of the pool. Type: String Pattern: `^wspool-[0-9a-z]{9}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationInProgressException ** The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/TerminateWorkspacesPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/TerminateWorkspacesPool) # TerminateWorkspacesPoolSession Terminates the pool session. ## Request Syntax ``` { "SessionId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [SessionId](#API_TerminateWorkspacesPoolSession_RequestSyntax) ** The identifier of the pool session. Type: String Length Constraints: Fixed length of 36. Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationInProgressException ** The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/TerminateWorkspacesPoolSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/TerminateWorkspacesPoolSession) # UpdateConnectClientAddIn Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in. ## Request Syntax ``` { "AddInId": "string", "Name": "string", "ResourceId": "string", "URL": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AddInId](#API_UpdateConnectClientAddIn_RequestSyntax) ** The identifier of the client add-in to update. Type: String Length Constraints: Fixed length of 36. Pattern: `[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}` Required: Yes ** [Name](#API_UpdateConnectClientAddIn_RequestSyntax) ** The name of the client add-in. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: `^.*$` Required: No ** [ResourceId](#API_UpdateConnectClientAddIn_RequestSyntax) ** The directory identifier for which the client add-in is configured. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: Yes ** [URL](#API_UpdateConnectClientAddIn_RequestSyntax) ** The endpoint URL of the Amazon Connect client add-in. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: `^(http|https)\://\S+` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/UpdateConnectClientAddIn) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/UpdateConnectClientAddIn) # UpdateConnectionAliasPermission 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](https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html). **Note** Before performing this operation, call [ DescribeConnectionAliases](https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html) 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. ## Request Syntax ``` { "AliasId": "string", "ConnectionAliasPermission": { "AllowAssociation": boolean, "SharedAccountId": "string" } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AliasId](#API_UpdateConnectionAliasPermission_RequestSyntax) ** The identifier of the connection alias that you want to update permissions for. Type: String Length Constraints: Minimum length of 13. Maximum length of 68. Pattern: `^wsca-[0-9a-z]{8,63}$` Required: Yes ** [ConnectionAliasPermission](#API_UpdateConnectionAliasPermission_RequestSyntax) ** Indicates whether to share or unshare the connection alias with the specified AWS account. Type: [ConnectionAliasPermission](API_ConnectionAliasPermission.md) object Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceAssociatedException ** The resource is associated with a directory. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/UpdateConnectionAliasPermission) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/UpdateConnectionAliasPermission) # UpdateRulesOfIpGroup Replaces the current rules of the specified IP access control group with the specified rules. ## Request Syntax ``` { "GroupId": "string", "UserRules": [ { "ipRule": "string", "ruleDesc": "string" } ] } ``` ## Request Parameters The request accepts the following data in JSON format. ** [GroupId](#API_UpdateRulesOfIpGroup_RequestSyntax) ** The identifier of the group. Type: String Pattern: `wsipg-[0-9a-z]{8,63}$` Required: Yes ** [UserRules](#API_UpdateRulesOfIpGroup_RequestSyntax) ** One or more rules. Type: Array of [IpRuleItem](API_IpRuleItem.md) objects Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/UpdateRulesOfIpGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/UpdateRulesOfIpGroup) # UpdateWorkspaceBundle Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see [ Update a Custom WorkSpaces Bundle](https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html). **Important** 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. ## Request Syntax ``` { "BundleId": "string", "ImageId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [BundleId](#API_UpdateWorkspaceBundle_RequestSyntax) ** The identifier of the bundle. Type: String Pattern: `^wsb-[0-9a-z]{8,63}$` Required: No ** [ImageId](#API_UpdateWorkspaceBundle_RequestSyntax) ** The identifier of the image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: No ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ResourceUnavailableException ** The specified resource is not available. ** message ** The exception error message. ** ResourceId ** The identifier of the resource that is not available. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/UpdateWorkspaceBundle) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/UpdateWorkspaceBundle) # UpdateWorkspaceImagePermission Shares or unshares an image with one account in the same AWS 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 AWS GovCloud (US), to copy images to and from other Regions, contact Support. For more information about sharing images, see [ Share or Unshare a Custom WorkSpaces Image](https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html). **Note** 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 AWS accounts isn't supported at this time in AWS GovCloud (US). To share BYOL images across accounts in AWS GovCloud (US), contact Support. ## Request Syntax ``` { "AllowCopyImage": boolean, "ImageId": "string", "SharedAccountId": "string" } ``` ## Request Parameters The request accepts the following data in JSON format. ** [AllowCopyImage](#API_UpdateWorkspaceImagePermission_RequestSyntax) ** The permission to copy the image. This permission can be revoked only after an image has been shared. Type: Boolean Required: Yes ** [ImageId](#API_UpdateWorkspaceImagePermission_RequestSyntax) ** The identifier of the image. Type: String Pattern: `wsi-[0-9a-z]{9,63}$` Required: Yes ** [SharedAccountId](#API_UpdateWorkspaceImagePermission_RequestSyntax) ** The identifier of the AWS account to share or unshare the image with. Before sharing the image, confirm that you are sharing to the correct AWS account ID. Type: String Pattern: `^\d{12}$` Required: Yes ## Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ** ResourceUnavailableException ** The specified resource is not available. ** message ** The exception error message. ** ResourceId ** The identifier of the resource that is not available. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/UpdateWorkspaceImagePermission) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/UpdateWorkspaceImagePermission) # UpdateWorkspacesPool Updates the specified pool. ## Request Syntax ``` { "ApplicationSettings": { "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "Capacity": { "DesiredUserSessions": number }, "Description": "string", "DirectoryId": "string", "PoolId": "string", "RunningMode": "string", "TimeoutSettings": { "DisconnectTimeoutInSeconds": number, "IdleDisconnectTimeoutInSeconds": number, "MaxUserDurationInSeconds": number } } ``` ## Request Parameters The request accepts the following data in JSON format. ** [ApplicationSettings](#API_UpdateWorkspacesPool_RequestSyntax) ** The persistent application settings for users in the pool. Type: [ApplicationSettingsRequest](API_ApplicationSettingsRequest.md) object Required: No ** [BundleId](#API_UpdateWorkspacesPool_RequestSyntax) ** The identifier of the bundle. Type: String Pattern: `^wsb-[0-9a-z]{8,63}$` Required: No ** [Capacity](#API_UpdateWorkspacesPool_RequestSyntax) ** The desired capacity for the pool. Type: [Capacity](API_Capacity.md) object Required: No ** [Description](#API_UpdateWorkspacesPool_RequestSyntax) ** Describes the specified pool to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `^[a-zA-Z0-9_./() -]+$` Required: No ** [DirectoryId](#API_UpdateWorkspacesPool_RequestSyntax) ** The identifier of the directory. Type: String Length Constraints: Minimum length of 10. Maximum length of 65. Pattern: `^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)` Required: No ** [PoolId](#API_UpdateWorkspacesPool_RequestSyntax) ** The identifier of the specified pool to update. Type: String Pattern: `^wspool-[0-9a-z]{9}$` Required: Yes ** [RunningMode](#API_UpdateWorkspacesPool_RequestSyntax) ** The desired running mode for the pool. The running mode can only be updated when the pool is in a stopped state. Type: String Valid Values: `AUTO_STOP | ALWAYS_ON` Required: No ** [TimeoutSettings](#API_UpdateWorkspacesPool_RequestSyntax) ** Indicates the timeout settings of the specified pool. Type: [TimeoutSettings](API_TimeoutSettings.md) object Required: No ## Response Syntax ``` { "WorkspacesPool": { "ApplicationSettings": { "S3BucketName": "string", "SettingsGroup": "string", "Status": "string" }, "BundleId": "string", "CapacityStatus": { "ActiveUserSessions": number, "ActualUserSessions": number, "AvailableUserSessions": number, "DesiredUserSessions": number }, "CreatedAt": number, "Description": "string", "DirectoryId": "string", "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string" } ], "PoolArn": "string", "PoolId": "string", "PoolName": "string", "RunningMode": "string", "State": "string", "TimeoutSettings": { "DisconnectTimeoutInSeconds": number, "IdleDisconnectTimeoutInSeconds": number, "MaxUserDurationInSeconds": number } } } ``` ## Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ** [WorkspacesPool](#API_UpdateWorkspacesPool_ResponseSyntax) ** Describes the specified pool. Type: [WorkspacesPool](API_WorkspacesPool.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** AccessDeniedException ** The user is not authorized to access a resource. HTTP Status Code: 400 ** InvalidParameterValuesException ** One or more parameter values are not valid. ** message ** The exception error message. HTTP Status Code: 400 ** InvalidResourceStateException ** The state of the resource is not valid for this operation. HTTP Status Code: 400 ** OperationInProgressException ** The properties of this WorkSpace are currently being modified. Try again in a moment. HTTP Status Code: 400 ** OperationNotSupportedException ** This operation is not supported. ** message ** The exception error message. ** reason ** The exception error reason. HTTP Status Code: 400 ** ResourceLimitExceededException ** Your resource limits have been exceeded. ** message ** The exception error message. HTTP Status Code: 400 ** ResourceNotFoundException ** The resource could not be found. ** message ** The resource could not be found. ** ResourceId ** The ID of the resource that could not be found. HTTP Status Code: 400 ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/workspaces-2015-04-08/UpdateWorkspacesPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/workspaces-2015-04-08/UpdateWorkspacesPool)