Há mais exemplos de AWS SDK disponíveis no repositório [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Exemplos de código para WorkSpaces usar AWS SDKs
Os exemplos de código a seguir mostram como usar a Amazon WorkSpaces com um kit de desenvolvimento de AWS software (SDK).
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
**Mais atributos**
+ **[ WorkSpaces Guia do desenvolvedor](https://docs.aws.amazon.com/workspaces/latest/userguide/workspaces-user-getting-started.html)** — Mais informações sobre WorkSpaces.
+ **[WorkSpaces Referência da API](https://docs.aws.amazon.com/workspaces/latest/api/welcome.html)** — Detalhes sobre todas as WorkSpaces ações disponíveis.
+ **[AWS Centro do desenvolvedor](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** — exemplos de código que você pode filtrar por categoria ou pesquisa de texto completo.
+ **[AWS Exemplos de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** — GitHub repositório com código completo nos idiomas preferidos. Inclui instruções para configurar e executar o código.
**Contents**
+ [Conceitos básicos](workspaces_code_examples_basics.md)
+ [Ações](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)
# Exemplos básicos de WorkSpaces uso AWS SDKs
Os exemplos de código a seguir mostram como usar o básico da Amazon WorkSpaces com AWS SDKs.
**Contents**
+ [Ações](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)
# Ações para WorkSpaces usar AWS SDKs
Os exemplos de código a seguir demonstram como realizar WorkSpaces ações individuais com AWS SDKs. Cada exemplo inclui um link para GitHub, onde você pode encontrar instruções para configurar e executar o código.
Os exemplos a seguir incluem apenas as ações mais utilizadas. Para obter uma lista completa, consulte a [Amazon WorkSpaces API Reference](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)
# Usar `CreateTags` com uma CLI
Os exemplos de código a seguir mostram como usar o `CreateTags`.
------
#### [ CLI ]
**AWS CLI**
**Para adicionar tags a um WorkSpace**
O `create-tags` exemplo a seguir adiciona as tags especificadas às especificadas WorkSpace.
```
aws workspaces create-tags \
--resource-id ws-dk1xzr417 \
--tags Key=Department,Value=Finance
```
Este comando não produz saída.
Para obter mais informações, consulte [ WorkSpaces Recursos de tags](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) no *Guia de WorkSpaces administração da Amazon*.
+ Para obter detalhes da API, consulte [CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/create-tags.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: esse exemplo adiciona uma nova tag a um espaço de trabalho chamado `ws-wsname`. A tag tem uma chave de “Name” e um valor-chave de `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
```
**Exemplo 2: esse exemplo adiciona várias tags a um espaço de trabalho chamado `ws-wsname`. Uma tag tem uma chave de “Name” e um valor-chave de `AWS_Workspace`; a outra tag tem uma chave de tag de “Stage” e um valor-chave de “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 obter detalhes da API, consulte [CreateTags](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo adiciona uma nova tag a um espaço de trabalho chamado `ws-wsname`. A tag tem uma chave de “Name” e um valor-chave de `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
```
**Exemplo 2: esse exemplo adiciona várias tags a um espaço de trabalho chamado `ws-wsname`. Uma tag tem uma chave de “Name” e um valor-chave de `AWS_Workspace`; a outra tag tem uma chave de tag de “Stage” e um valor-chave de “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 obter detalhes da API, consulte [CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `CreateWorkspaces` com uma CLI
Os exemplos de código a seguir mostram como usar o `CreateWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Exemplo 1: Para criar um AlwaysOn WorkSpace**
O `create-workspaces` exemplo a seguir cria um AlwaysOn WorkSpace para o usuário especificado, usando o diretório e o pacote especificados.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc
```
Saída:
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-kcqms853t",
"DirectoryId": "d-926722edaf",
"UserName": "Mateo",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc"
}
]
}
```
**Exemplo 2: Para criar um AutoStop WorkSpace**
O `create-workspaces` exemplo a seguir cria um AutoStop WorkSpace para o usuário especificado, usando o diretório e o pacote especificados.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}
```
Saída:
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-dk1xzr417",
"DirectoryId": "d-926722edaf",
"UserName": "Mary",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc"
}
]
}
```
**Exemplo 3: Para criar um usuário desacoplado WorkSpace**
O `create-workspaces` exemplo a seguir cria um usuário desacoplado WorkSpace definindo o nome de usuário como e especificando um WorkSpace nome`[UNDEFINED]`, ID do diretório e ID do pacote.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}
```
Saída:
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-abcd1234",
"DirectoryId": "d-926722edaf",
"UserName": "[UNDEFINED]",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc",
"WorkspaceName": "MaryWorkspace1"
}
]
}
```
Para obter mais informações, consulte [Iniciar um desktop virtual](https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html) no *Amazon WorkSpaces Administration Guide*.
+ Para obter detalhes da API, consulte [CreateWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/create-workspaces.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: Crie um WorkSpace para o pacote, o diretório e o usuário fornecidos.**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**Exemplo 2: Este exemplo cria vários WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ Para obter detalhes da API, consulte [CreateWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: Crie um WorkSpace para o pacote, o diretório e o usuário fornecidos.**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**Exemplo 2: Este exemplo cria vários WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ Para obter detalhes da API, consulte [CreateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `DeleteTags` com uma CLI
Os exemplos de código a seguir mostram como usar o `DeleteTags`.
------
#### [ CLI ]
**AWS CLI**
**Para excluir uma tag de um WorkSpace**
O `delete-tags` exemplo a seguir exclui a tag especificada da especificada WorkSpace.
```
aws workspaces delete-tags \
--resource-id ws-dk1xzr417 \
--tag-keys Department
```
Este comando não produz saída.
Para obter mais informações, consulte [ WorkSpaces Recursos de tags](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) no *Guia de WorkSpaces administração da Amazon*.
+ Para obter detalhes da API, consulte [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/delete-tags.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: esse exemplo remove a tag associada ao espaço de trabalho**
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo remove a tag associada ao espaço de trabalho**
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**Saída**:
```
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 obter detalhes da API, consulte [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `DescribeTags` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeTags`.
------
#### [ CLI ]
**AWS CLI**
**Para descrever as tags de um WorkSpace**
O `describe-tags` exemplo a seguir descreve as tags para o especificado WorkSpace.
```
aws workspaces describe-tags \
--resource-id ws-dk1xzr417
```
Saída:
```
{
"TagList": [
{
"Key": "Department",
"Value": "Finance"
}
]
}
```
Para obter mais informações, consulte [ WorkSpaces Recursos de tags](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) no *Guia de WorkSpaces administração da Amazon*.
+ Para obter detalhes da API, consulte [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-tags.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: esse exemplo busca a tag para o espaço de trabalho fornecido**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**Saída**:
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ Para obter detalhes da API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo busca a tag para o espaço de trabalho fornecido**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**Saída**:
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ Para obter detalhes da API, consulte [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `DescribeWorkspaceBundles` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeWorkspaceBundles`.
------
#### [ CLI ]
**AWS CLI**
**Para listar os pacotes fornecidos pela Amazon**
O `describe-workspace-bundles` exemplo a seguir lista os nomes e IDs os pacotes fornecidos pela Amazon, em formato de tabela e classificados por nome.
```
aws workspaces describe-workspace-bundles \
--owner AMAZON \
--query "Bundles[*].[Name, BundleId]"
```
Saída:
```
[
[
"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 obter mais informações, consulte [WorkSpaces pacotes e imagens](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-bundles.html) no *Guia de WorkSpaces administração da Amazon*.
+ Para obter detalhes da API, consulte [DescribeWorkspaceBundles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspace-bundles.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: essa amostra busca detalhes de todos os pacotes do Workspace na região atual**
```
Get-WKSWorkspaceBundle
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra busca detalhes de todos os pacotes do Workspace na região atual**
```
Get-WKSWorkspaceBundle
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `DescribeWorkspaceDirectories` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeWorkspaceDirectories`.
------
#### [ CLI ]
**AWS CLI**
**Para descrever um diretório registrado**
O exemplo `describe-workspace-directories` a seguir descreve o diretório registrado especificado.
```
aws workspaces describe-workspace-directories \
--directory-ids d-926722edaf
```
Saída:
```
{
"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 obter mais informações, consulte [Gerenciar diretórios para o WorkSpaces Personal](https://docs.aws.amazon.com/workspaces/latest/adminguide/manage-workspaces-directory.html) no *Guia de WorkSpaces Administração da Amazon*.
+ Para obter detalhes da API, consulte [DescribeWorkspaceDirectories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspace-directories.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: essa amostra lista os detalhes do diretório para diretórios registrados**
```
Get-WKSWorkspaceDirectory
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra lista os detalhes do diretório para diretórios registrados**
```
Get-WKSWorkspaceDirectory
```
**Saída**:
```
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 obter detalhes da API, consulte [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `DescribeWorkspaces` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para descrever um WorkSpace**
O `describe-workspaces` exemplo a seguir descreve o especificado WorkSpace.
```
aws workspaces describe-workspaces \
--workspace-ids ws-dk1xzr417
```
Saída:
```
{
"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 obter mais informações, consulte [Administrar seu WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html) no *Guia de WorkSpaces Administração da Amazon*.
+ Para obter detalhes da API, consulte [DescribeWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: recupera detalhes de todos os seus WorkSpaces para o pipeline.**
```
Get-WKSWorkspace
```
**Saída**:
```
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
```
**Exemplo 2: esse comando mostra os valores das propriedades secundárias de `WorkSpaceProperties` para um espaço de trabalho na região `us-west-2`. Para obter mais informações sobre as propriedades secundárias 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
```
**Saída**:
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**Exemplo 3: esse comando mostra o valor da propriedade secundária `RootVolumeSizeGib` de `WorkSpaceProperties` para um espaço de trabalho na região `us-west-2`. O tamanho do volume raiz, em GiB, é 80.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**Saída**:
```
80
```
+ Para obter detalhes da API, consulte [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: recupera detalhes de todos os seus WorkSpaces para o pipeline.**
```
Get-WKSWorkspace
```
**Saída**:
```
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
```
**Exemplo 2: esse comando mostra os valores das propriedades secundárias de `WorkSpaceProperties` para um espaço de trabalho na região `us-west-2`. Para obter mais informações sobre as propriedades secundárias 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
```
**Saída**:
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**Exemplo 3: esse comando mostra o valor da propriedade secundária `RootVolumeSizeGib` de `WorkSpaceProperties` para um espaço de trabalho na região `us-west-2`. O tamanho do volume raiz, em GiB, é 80.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**Saída**:
```
80
```
+ Para obter detalhes da API, consulte [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `DescribeWorkspacesConnectionStatus` com uma CLI
Os exemplos de código a seguir mostram como usar o `DescribeWorkspacesConnectionStatus`.
------
#### [ CLI ]
**AWS CLI**
**Para descrever o status da conexão de um WorkSpace**
O `describe-workspaces-connection-status` exemplo a seguir descreve o status da conexão especificada WorkSpace.
```
aws workspaces describe-workspaces-connection-status \
--workspace-ids ws-dk1xzr417
```
Saída:
```
{
"WorkspacesConnectionStatus": [
{
"WorkspaceId": "ws-dk1xzr417",
"ConnectionState": "CONNECTED",
"ConnectionStateCheckTimestamp": 1662526214.744
}
]
}
```
Para obter mais informações, consulte [Administrar seu WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html) no *Guia de WorkSpaces Administração da Amazon*.
+ Para obter detalhes da API, consulte [DescribeWorkspacesConnectionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces-connection-status.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: essa amostra busca o status da conexão para o espaço de trabalho especificado**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ Para obter detalhes da API, consulte [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: essa amostra busca o status da conexão para o espaço de trabalho especificado**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ Para obter detalhes da API, consulte [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `ModifyWorkspaceCreationProperties` com uma CLI
Os exemplos de código a seguir mostram como usar o `ModifyWorkspaceCreationProperties`.
------
#### [ CLI ]
**AWS CLI**
**Para modificar uma propriedade de WorkSpace criação de um diretório**
O exemplo `modify-workspace-creation-properties` a seguir ativa a propriedade `EnableInternetAccess` para o diretório especificado. Isso permite a atribuição automática de endereços IP públicos para o WorkSpaces criado para o diretório.
```
aws workspaces modify-workspace-creation-properties \
--resource-id d-926722edaf \
--workspace-creation-properties EnableInternetAccess=true
```
Este comando não produz saída.
Para obter mais informações, consulte [Atualizar os detalhes do seu diretório WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html) no *Guia de WorkSpaces Administração da Amazon*.
+ Para obter detalhes da API, consulte [ModifyWorkspaceCreationProperties](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-creation-properties.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: esse exemplo permite que o Modo de Manutenção e Acesso à Internet seja verdadeiro como valores padrão ao criar um espaço de trabalho**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo permite que o Modo de Manutenção e Acesso à Internet seja verdadeiro como valores padrão ao criar um espaço de trabalho**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `ModifyWorkspaceProperties` com uma CLI
Os exemplos de código a seguir mostram como usar o `ModifyWorkspaceProperties`.
------
#### [ CLI ]
**AWS CLI**
**Para modificar o modo de execução de um WorkSpace**
O `modify-workspace-properties` exemplo a seguir define o modo de execução do especificado WorkSpace para`AUTO_STOP`.
```
aws workspaces modify-workspace-properties \
--workspace-id ws-dk1xzr417 \
--workspace-properties RunningMode=AUTO_STOP
```
Este comando não produz saída.
Para obter mais informações, consulte [Modificar a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) no *Guia de WorkSpaces Administração da Amazon*.
+ Para obter detalhes da API, consulte [ModifyWorkspaceProperties](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-properties.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: esse exemplo altera a propriedade do modo de execução do espaço de trabalho para interrupção automática referente ao espaço de trabalho especificado**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera a propriedade do modo de execução do espaço de trabalho para interrupção automática referente ao espaço de trabalho especificado**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `ModifyWorkspaceState` com uma CLI
Os exemplos de código a seguir mostram como usar o `ModifyWorkspaceState`.
------
#### [ CLI ]
**AWS CLI**
**Para modificar o estado de um WorkSpace**
O `modify-workspace-state` exemplo a seguir define o estado do especificado WorkSpace para`ADMIN_MAINTENANCE`.
```
aws workspaces modify-workspace-state \
--workspace-id ws-dk1xzr417 \
--workspace-state ADMIN_MAINTENANCE
```
Este comando não produz saída.
Para obter mais informações, consulte a [WorkSpace manutenção](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html) no *Guia de WorkSpaces Administração da Amazon*.
+ Para obter detalhes da API, consulte [ModifyWorkspaceState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-state.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: esse exemplo altera o estado do espaço de trabalho especificado para Disponível**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo altera o estado do espaço de trabalho especificado para Disponível**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ Para obter detalhes da API, consulte [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `RebootWorkspaces` com uma CLI
Os exemplos de código a seguir mostram como usar o `RebootWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para reinicializar um WorkSpace**
O `reboot-workspaces` exemplo a seguir reinicializa o especificado WorkSpace.
```
aws workspaces reboot-workspaces \
--reboot-workspace-requests ws-dk1xzr417
```
Saída:
```
{
"FailedRequests": []
}
```
Para obter mais informações, consulte [Reboot a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/reboot-workspaces.html) no *Amazon WorkSpaces Administration Guide*.
+ Para obter detalhes da API, consulte [RebootWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/reboot-workspaces.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: Reinicializa o especificado WorkSpace.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemplo 2: Reinicializa várias WorkSpaces.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**Exemplo 3: recupera a coleção de todos os seus WorkSpaces e os canaliza IDs para o WorkSpaceId parâmetro - de Restart-WKSWorkspace, fazendo com que o WorkSpaces seja reiniciado.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ Para obter detalhes da API, consulte [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: Reinicializa o especificado WorkSpace.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemplo 2: Reinicializa várias WorkSpaces.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**Exemplo 3: recupera a coleção de todos os seus WorkSpaces e os canaliza IDs para o WorkSpaceId parâmetro - de Restart-WKSWorkspace, fazendo com que o WorkSpaces seja reiniciado.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ Para obter detalhes da API, consulte [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `RebuildWorkspaces` com uma CLI
Os exemplos de código a seguir mostram como usar o `RebuildWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para reconstruir um WorkSpace**
O `rebuild-workspaces` exemplo a seguir reconstrói o especificado. WorkSpace
```
aws workspaces rebuild-workspaces \
--rebuild-workspace-requests ws-dk1xzr417
```
Saída:
```
{
"FailedRequests": []
}
```
Para obter mais informações, consulte [Rebuild a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/rebuild-workspace.html) no *Amazon WorkSpaces Administration Guide*.
+ Para obter detalhes da API, consulte [RebuildWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/rebuild-workspaces.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: reconstrói o especificado. WorkSpace**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemplo 2: Recupera a coleção de todos os seus WorkSpaces e os canaliza IDs para o WorkSpaceId parâmetro - de Reset-WKSWorkspace, fazendo com que o WorkSpaces seja reconstruído.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ Para obter detalhes da API, consulte [RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: reconstrói o especificado. WorkSpace**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemplo 2: Recupera a coleção de todos os seus WorkSpaces e os canaliza IDs para o WorkSpaceId parâmetro - de Reset-WKSWorkspace, fazendo com que o WorkSpaces seja reconstruído.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ Para obter detalhes da API, consulte [RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `RegisterWorkspaceDirectory` com uma CLI
Os exemplos de código a seguir mostram como usar o `RegisterWorkspaceDirectory`.
------
#### [ CLI ]
**AWS CLI**
**Para registrar um diretório**
O `register-workspace-directory` exemplo a seguir registra o diretório especificado para uso com a Amazon WorkSpaces.
```
aws workspaces register-workspace-directory \
--directory-id d-926722edaf
```
Este comando não produz saída.
Para obter mais informações, consulte [Registrar um AWS diretório existente do Directory Service com WorkSpaces Personal](https://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html) no *Amazon WorkSpaces Administration Guide*.
+ Para obter detalhes da API, consulte [RegisterWorkspaceDirectory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/register-workspace-directory.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: esse exemplo registra o diretório especificado para o Workspaces Service**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ Para obter detalhes da API, consulte [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: esse exemplo registra o diretório especificado para o Workspaces Service**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ Para obter detalhes da API, consulte [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `StopWorkspaces` com uma CLI
Os exemplos de código a seguir mostram como usar o `StopWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para parar um AutoStop WorkSpace**
O `stop-workspaces` exemplo a seguir interrompe o especificado WorkSpace. Eles WorkSpace devem ter um modo de execução de`AutoStop`.
```
aws workspaces stop-workspaces \
--stop-workspace-requests WorkspaceId=ws-dk1xzr417
```
Saída:
```
{
"FailedRequests": []
}
```
Para obter mais informações, consulte [Stop and start an AutoStop WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html#stop-start-workspace) no *Amazon WorkSpaces Administration Guide*.
+ Para obter detalhes da API, consulte [StopWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/stop-workspaces.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: Interrompe várias WorkSpaces.**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**Exemplo 2: Recupera a coleção de todos os seus WorkSpaces e canaliza o IDs WorkSpaceId parâmetro - de Stop- WKSWorkspace fazendo com que o WorkSpaces seja interrompido.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**Exemplo 3: Este exemplo mostra como passar StopRequest objetos definindo o WorkSpaces a ser parado.**
```
$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 obter detalhes da API, consulte [StopWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: Interrompe várias WorkSpaces.**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**Exemplo 2: Recupera a coleção de todos os seus WorkSpaces e canaliza o IDs WorkSpaceId parâmetro - de Stop- WKSWorkspace fazendo com que o WorkSpaces seja interrompido.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**Exemplo 3: Este exemplo mostra como passar StopRequest objetos definindo o WorkSpaces a ser parado.**
```
$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 obter detalhes da API, consulte [StopWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------
# Usar `TerminateWorkspaces` com uma CLI
Os exemplos de código a seguir mostram como usar o `TerminateWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Para encerrar um WorkSpace**
O exemplo `terminate-workspaces` a seguir encerra o WorkSpace especificado.
```
aws workspaces terminate-workspaces \
--terminate-workspace-requests ws-dk1xzr417
```
Saída:
```
{
"FailedRequests": []
}
```
Para obter mais informações, consulte [Excluir um WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces.html) no *Guia de WorkSpaces Administração da Amazon*.
+ Para obter detalhes da API, consulte [TerminateWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/terminate-workspaces.html)em *Referência de AWS CLI Comandos*.
------
#### [ PowerShell ]
**Ferramentas para PowerShell V4**
**Exemplo 1: Encerra vários WorkSpaces. O uso da opção -Force impede que o cmdlet solicite confirmação.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**Exemplo 2: Recupera a coleção de todas as suas WorkSpaces e canaliza IDs para o WorkSpaceId parâmetro - de Remove-WKSWorkspace, encerrando todas as. WorkSpaces O cmdlet avisará antes que cada um WorkSpace seja encerrado. Para ignorar a solicitação de confirmação, adicione a opção -Force.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**Exemplo 3: Este exemplo mostra como passar TerminateRequest objetos definindo o WorkSpaces a ser encerrado. O cmdlet solicitará a confirmação antes de continuar, a menos que o parâmetro da opção -Force também seja especificado.**
```
$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 obter detalhes da API, consulte [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V4)*.
**Ferramentas para PowerShell V5**
**Exemplo 1: Encerra vários WorkSpaces. O uso da opção -Force impede que o cmdlet solicite confirmação.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**Exemplo 2: Recupera a coleção de todas as suas WorkSpaces e canaliza IDs para o WorkSpaceId parâmetro - de Remove-WKSWorkspace, encerrando todas as. WorkSpaces O cmdlet avisará antes que cada um WorkSpace seja encerrado. Para ignorar a solicitação de confirmação, adicione a opção -Force.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**Exemplo 3: Este exemplo mostra como passar TerminateRequest objetos definindo o WorkSpaces a ser encerrado. O cmdlet solicitará a confirmação antes de continuar, a menos que o parâmetro da opção -Force também seja especificado.**
```
$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 obter detalhes da API, consulte [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)em *Referência de Ferramentas da AWS para PowerShell cmdlet (V5)*.
------