Hay más ejemplos de AWS SDK disponibles en el GitHub repositorio de [ejemplos de AWS Doc SDK](https://github.com/awsdocs/aws-doc-sdk-examples).
Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.
# Ejemplos de código para usar WorkSpaces AWS SDKs
Los siguientes ejemplos de código muestran cómo utilizar Amazon WorkSpaces con un kit de desarrollo de AWS software (SDK).
Las *acciones* son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las distintas funciones de servicio, es posible ver las acciones en contexto en los escenarios relacionados.
**Más recursos**
+ **[ WorkSpaces Guía para desarrolladores](https://docs.aws.amazon.com/workspaces/latest/userguide/workspaces-user-getting-started.html)**: más información sobre WorkSpaces.
+ **[WorkSpaces Referencia de la API](https://docs.aws.amazon.com/workspaces/latest/api/welcome.html)**: detalles sobre todas WorkSpaces las acciones disponibles.
+ **[AWS Centro para desarrolladores](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)**: ejemplos de código que puedes filtrar por categoría o por búsqueda de texto completo.
+ **[AWS Ejemplos de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)**: GitHub repositorio con código completo en los idiomas preferidos. Incluye instrucciones para configurar y ejecutar el código.
**Contents**
+ [Conceptos básicos](workspaces_code_examples_basics.md)
+ [Acciones](workspaces_code_examples_actions.md)
+ [`CreateTags`](workspaces_example_workspaces_CreateTags_section.md)
+ [`CreateWorkspaces`](workspaces_example_workspaces_CreateWorkspaces_section.md)
+ [`DeleteTags`](workspaces_example_workspaces_DeleteTags_section.md)
+ [`DescribeTags`](workspaces_example_workspaces_DescribeTags_section.md)
+ [`DescribeWorkspaceBundles`](workspaces_example_workspaces_DescribeWorkspaceBundles_section.md)
+ [`DescribeWorkspaceDirectories`](workspaces_example_workspaces_DescribeWorkspaceDirectories_section.md)
+ [`DescribeWorkspaces`](workspaces_example_workspaces_DescribeWorkspaces_section.md)
+ [`DescribeWorkspacesConnectionStatus`](workspaces_example_workspaces_DescribeWorkspacesConnectionStatus_section.md)
+ [`ModifyWorkspaceCreationProperties`](workspaces_example_workspaces_ModifyWorkspaceCreationProperties_section.md)
+ [`ModifyWorkspaceProperties`](workspaces_example_workspaces_ModifyWorkspaceProperties_section.md)
+ [`ModifyWorkspaceState`](workspaces_example_workspaces_ModifyWorkspaceState_section.md)
+ [`RebootWorkspaces`](workspaces_example_workspaces_RebootWorkspaces_section.md)
+ [`RebuildWorkspaces`](workspaces_example_workspaces_RebuildWorkspaces_section.md)
+ [`RegisterWorkspaceDirectory`](workspaces_example_workspaces_RegisterWorkspaceDirectory_section.md)
+ [`StopWorkspaces`](workspaces_example_workspaces_StopWorkspaces_section.md)
+ [`TerminateWorkspaces`](workspaces_example_workspaces_TerminateWorkspaces_section.md)
# Ejemplos básicos de uso WorkSpaces AWS SDKs
Los siguientes ejemplos de código muestran cómo utilizar los conceptos básicos de Amazon WorkSpaces con AWS SDKs.
**Contents**
+ [Acciones](workspaces_code_examples_actions.md)
+ [`CreateTags`](workspaces_example_workspaces_CreateTags_section.md)
+ [`CreateWorkspaces`](workspaces_example_workspaces_CreateWorkspaces_section.md)
+ [`DeleteTags`](workspaces_example_workspaces_DeleteTags_section.md)
+ [`DescribeTags`](workspaces_example_workspaces_DescribeTags_section.md)
+ [`DescribeWorkspaceBundles`](workspaces_example_workspaces_DescribeWorkspaceBundles_section.md)
+ [`DescribeWorkspaceDirectories`](workspaces_example_workspaces_DescribeWorkspaceDirectories_section.md)
+ [`DescribeWorkspaces`](workspaces_example_workspaces_DescribeWorkspaces_section.md)
+ [`DescribeWorkspacesConnectionStatus`](workspaces_example_workspaces_DescribeWorkspacesConnectionStatus_section.md)
+ [`ModifyWorkspaceCreationProperties`](workspaces_example_workspaces_ModifyWorkspaceCreationProperties_section.md)
+ [`ModifyWorkspaceProperties`](workspaces_example_workspaces_ModifyWorkspaceProperties_section.md)
+ [`ModifyWorkspaceState`](workspaces_example_workspaces_ModifyWorkspaceState_section.md)
+ [`RebootWorkspaces`](workspaces_example_workspaces_RebootWorkspaces_section.md)
+ [`RebuildWorkspaces`](workspaces_example_workspaces_RebuildWorkspaces_section.md)
+ [`RegisterWorkspaceDirectory`](workspaces_example_workspaces_RegisterWorkspaceDirectory_section.md)
+ [`StopWorkspaces`](workspaces_example_workspaces_StopWorkspaces_section.md)
+ [`TerminateWorkspaces`](workspaces_example_workspaces_TerminateWorkspaces_section.md)
# Acciones para WorkSpaces usar AWS SDKs
Los siguientes ejemplos de código muestran cómo realizar WorkSpaces acciones individuales con AWS SDKs. Cada ejemplo incluye un enlace a GitHub, donde puede encontrar instrucciones para configurar y ejecutar el código.
Los siguientes ejemplos incluyen solo las acciones que se utilizan con mayor frecuencia. Para obtener una lista completa, consulta la [referencia de las WorkSpaces API de Amazon](https://docs.aws.amazon.com/workspaces/latest/api/welcome.html).
**Topics**
+ [`CreateTags`](workspaces_example_workspaces_CreateTags_section.md)
+ [`CreateWorkspaces`](workspaces_example_workspaces_CreateWorkspaces_section.md)
+ [`DeleteTags`](workspaces_example_workspaces_DeleteTags_section.md)
+ [`DescribeTags`](workspaces_example_workspaces_DescribeTags_section.md)
+ [`DescribeWorkspaceBundles`](workspaces_example_workspaces_DescribeWorkspaceBundles_section.md)
+ [`DescribeWorkspaceDirectories`](workspaces_example_workspaces_DescribeWorkspaceDirectories_section.md)
+ [`DescribeWorkspaces`](workspaces_example_workspaces_DescribeWorkspaces_section.md)
+ [`DescribeWorkspacesConnectionStatus`](workspaces_example_workspaces_DescribeWorkspacesConnectionStatus_section.md)
+ [`ModifyWorkspaceCreationProperties`](workspaces_example_workspaces_ModifyWorkspaceCreationProperties_section.md)
+ [`ModifyWorkspaceProperties`](workspaces_example_workspaces_ModifyWorkspaceProperties_section.md)
+ [`ModifyWorkspaceState`](workspaces_example_workspaces_ModifyWorkspaceState_section.md)
+ [`RebootWorkspaces`](workspaces_example_workspaces_RebootWorkspaces_section.md)
+ [`RebuildWorkspaces`](workspaces_example_workspaces_RebuildWorkspaces_section.md)
+ [`RegisterWorkspaceDirectory`](workspaces_example_workspaces_RegisterWorkspaceDirectory_section.md)
+ [`StopWorkspaces`](workspaces_example_workspaces_StopWorkspaces_section.md)
+ [`TerminateWorkspaces`](workspaces_example_workspaces_TerminateWorkspaces_section.md)
# Utilizar `CreateTags` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `CreateTags`.
------
#### [ CLI ]
**AWS CLI**
**Para añadir etiquetas a un WorkSpace**
En el siguiente `create-tags` ejemplo, se agregan las etiquetas especificadas a las especificadas WorkSpace.
```
aws workspaces create-tags \
--resource-id ws-dk1xzr417 \
--tags Key=Department,Value=Finance
```
Este comando no genera ninguna salida.
Para obtener más información, consulta [ WorkSpaces los recursos sobre etiquetas](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/create-tags.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se añade una etiqueta nueva a un espacio de trabajo denominado `ws-wsname`. La etiqueta tiene la clave “Name” y el valor de clave `AWS_Workspace`.**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag
```
**Ejemplo 2: En este ejemplo se añaden varias etiquetas a un espacio de trabajo denominado `ws-wsname`. Una etiqueta tiene la clave “Name” y el valor de clave `AWS_Workspace`; la otra etiqueta tiene la clave de etiqueta “Stage” y el valor de clave “Test”.**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
$tag2 = New-Object Amazon.WorkSpaces.Model.Tag
$tag2.Key = "Stage"
$tag2.Value = "Test"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag,$tag2
```
+ Para obtener más información sobre la API, consulte [CreateTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se añade una etiqueta nueva a un espacio de trabajo denominado `ws-wsname`. La etiqueta tiene la clave “Name” y el valor de clave `AWS_Workspace`.**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag
```
**Ejemplo 2: En este ejemplo se añaden varias etiquetas a un espacio de trabajo denominado `ws-wsname`. Una etiqueta tiene la clave “Name” y el valor de clave `AWS_Workspace`; la otra etiqueta tiene la clave de etiqueta “Stage” y el valor de clave “Test”.**
```
$tag = New-Object Amazon.WorkSpaces.Model.Tag
$tag.Key = "Name"
$tag.Value = "AWS_Workspace"
$tag2 = New-Object Amazon.WorkSpaces.Model.Tag
$tag2.Key = "Stage"
$tag2.Value = "Test"
New-WKSTag -Region us-west-2 -WorkspaceId ws-wsname -Tag $tag,$tag2
```
+ Para obtener más información sobre la API, consulte [CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `CreateWorkspaces` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `CreateWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Ejemplo 1: Para crear un AlwaysOn WorkSpace**
En el siguiente `create-workspaces` ejemplo, se crea una AlwaysOn WorkSpace para el usuario especificado, utilizando el directorio y el paquete especificados.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc
```
Salida:
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-kcqms853t",
"DirectoryId": "d-926722edaf",
"UserName": "Mateo",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc"
}
]
}
```
**Ejemplo 2: Para crear un AutoStop WorkSpace**
En el siguiente `create-workspaces` ejemplo, se crea una AutoStop WorkSpace para el usuario especificado, utilizando el directorio y el paquete especificados.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}
```
Salida:
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-dk1xzr417",
"DirectoryId": "d-926722edaf",
"UserName": "Mary",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc"
}
]
}
```
**Ejemplo 3: Para crear un desacoplado por usuarios WorkSpace**
En el siguiente `create-workspaces` ejemplo, se crea una disociación de usuarios WorkSpace al establecer el nombre de usuario en y especificar un WorkSpace nombre`[UNDEFINED]`, un identificador de directorio y un identificador de paquete.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}
```
Salida:
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-abcd1234",
"DirectoryId": "d-926722edaf",
"UserName": "[UNDEFINED]",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc",
"WorkspaceName": "MaryWorkspace1"
}
]
}
```
Para obtener más información, consulte [Lanzar un escritorio virtual](https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [CreateWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/create-workspaces.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: cree una WorkSpace para el paquete, el directorio y el usuario suministrados.**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**Ejemplo 2: En este ejemplo se crean varios WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ Para obtener más información sobre la API, consulte [CreateWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: cree un WorkSpace para el paquete, el directorio y el usuario proporcionados.**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**Ejemplo 2: En este ejemplo se crean varios WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ Para obtener más información sobre la API, consulte [CreateWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
------
# Utilizar `DeleteTags` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `DeleteTags`.
------
#### [ CLI ]
**AWS CLI**
**Para eliminar una etiqueta de un WorkSpace**
En el siguiente `delete-tags` ejemplo, se elimina la etiqueta especificada de la especificada WorkSpace.
```
aws workspaces delete-tags \
--resource-id ws-dk1xzr417 \
--tag-keys Department
```
Este comando no genera ninguna salida.
Para obtener más información, consulta [ WorkSpaces los recursos sobre etiquetas](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/delete-tags.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se elimina la etiqueta asociada a la instancia de WorkSpaces**.
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSTag (DeleteTags)" on target "ws-w10b3abcd".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se elimina la etiqueta asociada a la instancia de WorkSpaces**.
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**Salida:**
```
Confirm
Are you sure you want to perform this action?
Performing the operation "Remove-WKSTag (DeleteTags)" on target "ws-w10b3abcd".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): Y
```
+ Para obtener más información sobre la API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `DescribeTags` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `DescribeTags`.
------
#### [ CLI ]
**AWS CLI**
**Para describir las etiquetas de un WorkSpace**
En el siguiente `describe-tags` ejemplo, se describen las etiquetas del objeto especificado WorkSpace.
```
aws workspaces describe-tags \
--resource-id ws-dk1xzr417
```
Salida:
```
{
"TagList": [
{
"Key": "Department",
"Value": "Finance"
}
]
}
```
Para obtener más información, consulta [ WorkSpaces los recursos sobre etiquetas](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-tags.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se busca la etiqueta del espacio de trabajo especificado**.
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**Salida:**
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ Para obtener más información sobre la API, consulte [DescribeTags Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se busca la etiqueta del espacio de trabajo especificado**.
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**Salida:**
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ Para obtener más información sobre la API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `DescribeWorkspaceBundles` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `DescribeWorkspaceBundles`.
------
#### [ CLI ]
**AWS CLI**
**Para enumerar los paquetes proporcionados por Amazon**
El siguiente `describe-workspace-bundles` ejemplo muestra los nombres y IDs los paquetes proporcionados por Amazon, en formato de tabla y ordenados por nombre.
```
aws workspaces describe-workspace-bundles \
--owner AMAZON \
--query "Bundles[*].[Name, BundleId]"
```
Salida:
```
[
[
"Standard with Amazon Linux 2",
"wsb-clj85qzj1"
],
[
"Performance with Windows 10 (Server 2016 based)",
"wsb-gm4d5tx2v"
],
[
"PowerPro with Windows 7",
"wsb-1pzkp0bx4"
],
[
"Power with Amazon Linux 2",
"wsb-2bs6k5lgn"
],
[
"Graphics with Windows 10 (Server 2019 based)",
"wsb-03gyjnfyy"
],
...
]
```
Para obtener más información, consulta [WorkSpaces los paquetes y las imágenes](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-bundles.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceBundles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspace-bundles.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se obtienen los detalles de todas las agrupaciones del espacio de trabajo de la región actual**.
```
Get-WKSWorkspaceBundle
```
**Salida:**
```
BundleId : wsb-sfhdgv342
ComputeType : Amazon.WorkSpaces.Model.ComputeType
Description : This bundle is custom
ImageId : wsi-235aeqges
LastUpdatedTime : 12/26/2019 06:44:07
Name : CustomBundleTest
Owner : 233816212345
RootStorage : Amazon.WorkSpaces.Model.RootStorage
UserStorage : Amazon.WorkSpaces.Model.UserStorage
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceBundles Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtienen los detalles de todas las agrupaciones del espacio de trabajo de la región actual**.
```
Get-WKSWorkspaceBundle
```
**Salida:**
```
BundleId : wsb-sfhdgv342
ComputeType : Amazon.WorkSpaces.Model.ComputeType
Description : This bundle is custom
ImageId : wsi-235aeqges
LastUpdatedTime : 12/26/2019 06:44:07
Name : CustomBundleTest
Owner : 233816212345
RootStorage : Amazon.WorkSpaces.Model.RootStorage
UserStorage : Amazon.WorkSpaces.Model.UserStorage
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `DescribeWorkspaceDirectories` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `DescribeWorkspaceDirectories`.
------
#### [ CLI ]
**AWS CLI**
**Para describir un directorio registrado**
En el siguiente ejemplo de `describe-workspace-directories`, se describe el directorio registrado indicado.
```
aws workspaces describe-workspace-directories \
--directory-ids d-926722edaf
```
Salida:
```
{
"Directories": [
{
"DirectoryId": "d-926722edaf",
"Alias": "d-926722edaf",
"DirectoryName": "example.com",
"RegistrationCode": "WSpdx+9RJ8JT",
"SubnetIds": [
"subnet-9d19c4c6",
"subnet-500d5819"
],
"DnsIpAddresses": [
"172.16.1.140",
"172.16.0.30"
],
"CustomerUserName": "Administrator",
"IamRoleId": "arn:aws:iam::123456789012:role/workspaces_DefaultRole",
"DirectoryType": "SIMPLE_AD",
"WorkspaceSecurityGroupId": "sg-0d89e927e5645d7c5",
"State": "REGISTERED",
"WorkspaceCreationProperties": {
"EnableInternetAccess": false,
"UserEnabledAsLocalAdministrator": true,
"EnableMaintenanceMode": true
},
"WorkspaceAccessProperties": {
"DeviceTypeWindows": "ALLOW",
"DeviceTypeOsx": "ALLOW",
"DeviceTypeWeb": "DENY",
"DeviceTypeIos": "ALLOW",
"DeviceTypeAndroid": "ALLOW",
"DeviceTypeChromeOs": "ALLOW",
"DeviceTypeZeroClient": "ALLOW",
"DeviceTypeLinux": "DENY"
},
"Tenancy": "SHARED",
"SelfservicePermissions": {
"RestartWorkspace": "ENABLED",
"IncreaseVolumeSize": "DISABLED",
"ChangeComputeType": "DISABLED",
"SwitchRunningMode": "DISABLED",
"RebuildWorkspace": "DISABLED"
}
}
]
}
```
Para obtener más información, consulte [Administrar directorios para WorkSpaces personal](https://docs.aws.amazon.com/workspaces/latest/adminguide/manage-workspaces-directory.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceDirectories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspace-directories.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se muestran los detalles de directorio de los directorios registrados**.
```
Get-WKSWorkspaceDirectory
```
**Salida:**
```
Alias : TestWorkspace
CustomerUserName : Administrator
DirectoryId : d-123414a369
DirectoryName : TestDirectory.com
DirectoryType : MicrosoftAD
DnsIpAddresses : {172.31.43.45, 172.31.2.97}
IamRoleId : arn:aws:iam::761234567801:role/workspaces_RoleDefault
IpGroupIds : {}
RegistrationCode : WSpdx+4RRT43
SelfservicePermissions : Amazon.WorkSpaces.Model.SelfservicePermissions
State : REGISTERED
SubnetIds : {subnet-1m3m7b43, subnet-ard11aba}
Tenancy : SHARED
WorkspaceAccessProperties : Amazon.WorkSpaces.Model.WorkspaceAccessProperties
WorkspaceCreationProperties : Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties
WorkspaceSecurityGroupId : sg-0ed2441234a123c43
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceDirectories Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se muestran los detalles de directorio de los directorios registrados**.
```
Get-WKSWorkspaceDirectory
```
**Salida:**
```
Alias : TestWorkspace
CustomerUserName : Administrator
DirectoryId : d-123414a369
DirectoryName : TestDirectory.com
DirectoryType : MicrosoftAD
DnsIpAddresses : {172.31.43.45, 172.31.2.97}
IamRoleId : arn:aws:iam::761234567801:role/workspaces_RoleDefault
IpGroupIds : {}
RegistrationCode : WSpdx+4RRT43
SelfservicePermissions : Amazon.WorkSpaces.Model.SelfservicePermissions
State : REGISTERED
SubnetIds : {subnet-1m3m7b43, subnet-ard11aba}
Tenancy : SHARED
WorkspaceAccessProperties : Amazon.WorkSpaces.Model.WorkspaceAccessProperties
WorkspaceCreationProperties : Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties
WorkspaceSecurityGroupId : sg-0ed2441234a123c43
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `DescribeWorkspaces` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `DescribeWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para describir un WorkSpace**
El siguiente `describe-workspaces` ejemplo describe lo especificado WorkSpace.
```
aws workspaces describe-workspaces \
--workspace-ids ws-dk1xzr417
```
Salida:
```
{
"Workspaces": [
{
"WorkspaceId": "ws-dk1xzr417",
"DirectoryId": "d-926722edaf",
"UserName": "Mary",
"IpAddress": "172.16.0.175",
"State": "STOPPED",
"BundleId": "wsb-0zsvgp8fc",
"SubnetId": "subnet-500d5819",
"ComputerName": "WSAMZN-RBSLTTD9",
"WorkspaceProperties": {
"RunningMode": "AUTO_STOP",
"RunningModeAutoStopTimeoutInMinutes": 60,
"RootVolumeSizeGib": 80,
"UserVolumeSizeGib": 10,
"ComputeTypeName": "VALUE"
},
"ModificationStates": []
}
]
}
```
Para obtener más información, consulta [Administra tu WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [DescribeWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: Recupera los detalles de todos los que llevas WorkSpaces a la canalización.**
```
Get-WKSWorkspace
```
**Salida:**
```
BundleId : wsb-1a2b3c4d
ComputerName :
DirectoryId : d-1a2b3c4d
ErrorCode :
ErrorMessage :
IpAddress :
RootVolumeEncryptionEnabled : False
State : PENDING
SubnetId :
UserName : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey :
WorkspaceId : ws-1a2b3c4d
WorkspaceProperties : Amazon.WorkSpaces.Model.WorkspaceProperties
```
**Ejemplo 2: Este comando muestra los valores de las propiedades secundarias de `WorkSpaceProperties` para un espacio de trabajo de la región `us-west-2`. Para obtener más información sobre las propiedades secundarias de`WorkSpaceProperties`, consulte https://docs.aws.amazon.com/workspaces/ latest/api/API \$1 WorkspaceProperties .html.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties
```
**Salida:**
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**Ejemplo 3: Este comando muestra el valor de la propiedad secundaria `RootVolumeSizeGib` de `WorkSpaceProperties` para un espacio de trabajo en la región `us-west-2`. El tamaño del volumen de la raíz, en GiB, es 80.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**Salida:**
```
80
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (*V4).
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Recupera los detalles de todos los que llevas WorkSpaces a la canalización.**
```
Get-WKSWorkspace
```
**Salida:**
```
BundleId : wsb-1a2b3c4d
ComputerName :
DirectoryId : d-1a2b3c4d
ErrorCode :
ErrorMessage :
IpAddress :
RootVolumeEncryptionEnabled : False
State : PENDING
SubnetId :
UserName : myuser
UserVolumeEncryptionEnabled : False
VolumeEncryptionKey :
WorkspaceId : ws-1a2b3c4d
WorkspaceProperties : Amazon.WorkSpaces.Model.WorkspaceProperties
```
**Ejemplo 2: Este comando muestra los valores de las propiedades secundarias de `WorkSpaceProperties` para un espacio de trabajo de la región `us-west-2`. Para obtener más información sobre las propiedades secundarias de`WorkSpaceProperties`, consulte https://docs.aws.amazon.com/workspaces/ latest/api/API \$1 WorkspaceProperties .html.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties
```
**Salida:**
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**Ejemplo 3: Este comando muestra el valor de la propiedad secundaria `RootVolumeSizeGib` de `WorkSpaceProperties` para un espacio de trabajo en la región `us-west-2`. El tamaño del volumen de la raíz, en GiB, es 80.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**Salida:**
```
80
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
------
# Utilizar `DescribeWorkspacesConnectionStatus` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `DescribeWorkspacesConnectionStatus`.
------
#### [ CLI ]
**AWS CLI**
**Para describir el estado de conexión de un WorkSpace**
El siguiente `describe-workspaces-connection-status` ejemplo describe el estado de conexión del especificado WorkSpace.
```
aws workspaces describe-workspaces-connection-status \
--workspace-ids ws-dk1xzr417
```
Salida:
```
{
"WorkspacesConnectionStatus": [
{
"WorkspaceId": "ws-dk1xzr417",
"ConnectionState": "CONNECTED",
"ConnectionStateCheckTimestamp": 1662526214.744
}
]
}
```
Para obtener más información, consulta [Administra tu WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [DescribeWorkspacesConnectionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces-connection-status.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se obtiene el estado de la conexión del espacio de trabajo especificado.**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspacesConnectionStatus Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se obtiene el estado de la conexión del espacio de trabajo especificado.**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ Para obtener más información sobre la API, consulte [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `ModifyWorkspaceCreationProperties` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `ModifyWorkspaceCreationProperties`.
------
#### [ CLI ]
**AWS CLI**
**Para modificar una propiedad de WorkSpace creación de un directorio**
En el siguiente ejemplo de `modify-workspace-creation-properties`, se habilita la propiedad `EnableInternetAccess` para el directorio especificado. Esto permite la asignación automática de direcciones IP públicas a las direcciones IP WorkSpaces creadas para el directorio.
```
aws workspaces modify-workspace-creation-properties \
--resource-id d-926722edaf \
--workspace-creation-properties EnableInternetAccess=true
```
Este comando no genera ninguna salida.
Para obtener más información, consulta [Actualizar los detalles de tu directorio WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceCreationProperties](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-creation-properties.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se establece el acceso a Internet y el modo de mantenimiento en true como valores predeterminados al crear un espacio de trabajo**.
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceCreationProperties Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se establece el acceso a Internet y el modo de mantenimiento en true como valores predeterminados al crear un espacio de trabajo**.
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `ModifyWorkspaceProperties` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `ModifyWorkspaceProperties`.
------
#### [ CLI ]
**AWS CLI**
**Para modificar el modo de ejecución de un WorkSpace**
El siguiente `modify-workspace-properties` ejemplo establece el modo de ejecución del especificado WorkSpace en`AUTO_STOP`.
```
aws workspaces modify-workspace-properties \
--workspace-id ws-dk1xzr417 \
--workspace-properties RunningMode=AUTO_STOP
```
Este comando no genera ninguna salida.
Para obtener más información, consulta [Modificar a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceProperties](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-properties.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se cambia la propiedad del modo de ejecución del espacio de trabajo a Parada automática para el espacio de trabajo especificado**.
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceProperties Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia la propiedad del modo de ejecución del espacio de trabajo a Parada automática para el espacio de trabajo especificado**.
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `ModifyWorkspaceState` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `ModifyWorkspaceState`.
------
#### [ CLI ]
**AWS CLI**
**Para modificar el estado de un WorkSpace**
En el siguiente `modify-workspace-state` ejemplo, se establece el estado del especificado WorkSpace en`ADMIN_MAINTENANCE`.
```
aws workspaces modify-workspace-state \
--workspace-id ws-dk1xzr417 \
--workspace-state ADMIN_MAINTENANCE
```
Este comando no genera ninguna salida.
Para obtener más información, consulta el [WorkSpace mantenimiento](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-state.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se cambia el estado del espacio de trabajo especificado a Disponible**.
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceState Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se cambia el estado del espacio de trabajo especificado a Disponible**.
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ Para obtener más información sobre la API, consulte [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `RebootWorkspaces` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `RebootWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para reiniciar un WorkSpace**
En el siguiente `reboot-workspaces` ejemplo, se reinicia la unidad especificada WorkSpace.
```
aws workspaces reboot-workspaces \
--reboot-workspace-requests ws-dk1xzr417
```
Salida:
```
{
"FailedRequests": []
}
```
Para obtener más información, consulta [Reboot a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/reboot-workspaces.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [RebootWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/reboot-workspaces.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: Reinicia el especificado WorkSpace.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Ejemplo 2: Reinicia varios. WorkSpaces**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**Ejemplo 3: recupera la colección de todos los suyos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro - de Restart-WKSWorkspace, lo que provoca que se WorkSpaces reinicie.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)Reference (*V4).
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Reinicia lo especificado. WorkSpace**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Ejemplo 2: Reinicia varios. WorkSpaces**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**Ejemplo 3: recupera la colección de todos los suyos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro - de Restart-WKSWorkspace, lo que provoca que se WorkSpaces reinicie.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ Para obtener más información sobre la API, consulte *Herramientas de AWS para PowerShell Cmdlet [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)Reference (*V5).
------
# Utilizar `RebuildWorkspaces` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `RebuildWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para reconstruir un WorkSpace**
En el siguiente `rebuild-workspaces` ejemplo, se reconstruye lo especificado WorkSpace.
```
aws workspaces rebuild-workspaces \
--rebuild-workspace-requests ws-dk1xzr417
```
Salida:
```
{
"FailedRequests": []
}
```
Para obtener más información, consulte [Rebuild a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/rebuild-workspace.html) en la *Amazon WorkSpaces Administration Guide*.
+ Para obtener más información sobre la API, consulte [RebuildWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/rebuild-workspaces.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: Reconstruye lo especificado WorkSpace.**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Ejemplo 2: recupera la colección de todos los suyos WorkSpaces y los IDs canaliza al WorkSpaceId parámetro de restablecimientoWKSWorkspace, lo que provoca su WorkSpaces reconstrucción.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ Para obtener más información sobre la API, consulte [RebuildWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (*V4).
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Reconstruye lo especificado. WorkSpace**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Ejemplo 2: recupera la colección de todos los suyos WorkSpaces y los IDs canaliza al WorkSpaceId parámetro de restablecimientoWKSWorkspace, lo que provoca su WorkSpaces reconstrucción.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ Para obtener más información sobre la API, consulte [RebuildWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (*V5).
------
# Utilizar `RegisterWorkspaceDirectory` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `RegisterWorkspaceDirectory`.
------
#### [ CLI ]
**AWS CLI**
**Para registrar un directorio**
En el siguiente `register-workspace-directory` ejemplo, se registra el directorio especificado para su uso con Amazon WorkSpaces.
```
aws workspaces register-workspace-directory \
--directory-id d-926722edaf
```
Este comando no genera ninguna salida.
Para obtener más información, consulte [Registrar un AWS directorio existente de Directory Service con WorkSpaces Personal](https://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [RegisterWorkspaceDirectory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/register-workspace-directory.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: En este ejemplo se registra el directorio especificado para Workspaces Service**.
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ Para obtener más información sobre la API, consulte [RegisterWorkspaceDirectory Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: En este ejemplo se registra el directorio especificado para Workspaces Service**.
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ Para obtener más información sobre la API, consulte [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v5/reference)la *referencia de Herramientas de AWS para PowerShell cmdlets (*V5).
------
# Utilizar `StopWorkspaces` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `StopWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para detener un AutoStop WorkSpace**
El siguiente `stop-workspaces` ejemplo detiene lo especificado WorkSpace. WorkSpace Debe tener un modo de ejecución de`AutoStop`.
```
aws workspaces stop-workspaces \
--stop-workspace-requests WorkspaceId=ws-dk1xzr417
```
Salida:
```
{
"FailedRequests": []
}
```
Para obtener más información, consulta [Stop and start an AutoStop WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html#stop-start-workspace) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [StopWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/stop-workspaces.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: Detiene varios WorkSpaces.**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**Ejemplo 2: recupera la colección de todos sus datos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro Stop, WKSWorkspace lo que provoca WorkSpaces que se detenga.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**Ejemplo 3: En este ejemplo se muestra cómo pasar StopRequest los objetos que definen lo WorkSpaces que se debe detener.**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Stop-WKSWorkspace -Request $arrRequest
```
+ Para obtener más información sobre la API, consulte [StopWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Detiene varios WorkSpaces.**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**Ejemplo 2: recupera la colección de todos sus datos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro Stop, WKSWorkspace lo que provoca WorkSpaces que se detenga.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**Ejemplo 3: En este ejemplo se muestra cómo pasar StopRequest los objetos que definen lo WorkSpaces que se debe detener.**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.StopRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Stop-WKSWorkspace -Request $arrRequest
```
+ Para obtener más información sobre la API, consulte [StopWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
------
# Utilizar `TerminateWorkspaces` con una CLI
Los siguientes ejemplos de código muestran cómo utilizar `TerminateWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para finalizar un WorkSpace**
En el siguiente ejemplo de `terminate-workspaces`, finaliza el WorkSpace especificado.
```
aws workspaces terminate-workspaces \
--terminate-workspace-requests ws-dk1xzr417
```
Salida:
```
{
"FailedRequests": []
}
```
Para obtener más información, consulta [Eliminar un WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces.html) en la *Guía de WorkSpaces administración de Amazon*.
+ Para obtener más información sobre la API, consulte [TerminateWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/terminate-workspaces.html)la *Referencia de AWS CLI comandos*.
------
#### [ PowerShell ]
**Herramientas para la PowerShell versión 4**
**Ejemplo 1: Termina varios WorkSpaces. El uso del modificador -Force impide que el cmdlet solicite confirmación.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**Ejemplo 2: recupera la colección de todos los suyos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro - de Remove-WKSWorkspace, finalizando todos los. WorkSpaces El cmdlet avisará antes de que finalice cada uno de ellos. WorkSpace Añada el modificador -Force para suprimir la solicitud de confirmación.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**Ejemplo 3: en este ejemplo se muestra cómo pasar los TerminateRequest objetos que definen lo que se va WorkSpaces a terminar. El cmdlet solicitará confirmación antes de continuar, a menos que se especifique el modificador -Force.**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Remove-WKSWorkspace -Request $arrRequest
```
+ Para obtener más información sobre la API, consulte [TerminateWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v4/reference)*Cmdlet Reference (V4)*.
**Herramientas para la versión 5 PowerShell **
**Ejemplo 1: Termina varios WorkSpaces. El uso del modificador -Force impide que el cmdlet solicite confirmación.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**Ejemplo 2: recupera la colección de todos los suyos WorkSpaces y los canaliza IDs al WorkSpaceId parámetro - de Remove-WKSWorkspace, finalizando todos los. WorkSpaces El cmdlet avisará antes de que finalice cada uno de ellos. WorkSpace Añada el modificador -Force para suprimir la solicitud de confirmación.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**Ejemplo 3: en este ejemplo se muestra cómo pasar los TerminateRequest objetos que definen lo que se va WorkSpaces a terminar. El cmdlet solicitará confirmación antes de continuar, a menos que se especifique el modificador -Force.**
```
$arrRequest = @()
$request1 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request1.WorkspaceId = 'ws-12345678'
$arrRequest += $request1
$request2 = New-Object Amazon.WorkSpaces.Model.TerminateRequest
$request2.WorkspaceId = 'ws-abcdefgh'
$arrRequest += $request2
Remove-WKSWorkspace -Request $arrRequest
```
+ Para obtener más información sobre la API, consulte [TerminateWorkspaces Herramientas de AWS para PowerShell](https://docs.aws.amazon.com/powershell/v5/reference)*Cmdlet Reference (V5)*.
------