Exemplos do WorkSpaces usando a AWS CLI - AWS Command Line Interface
Ações

Esta documentação é somente para a versão 1 da AWS CLI. Para obter a documentação relacionada à AWS CLI versão 2, consulte o Guia do usuário da versão 2.

Exemplos do WorkSpaces usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o WorkSpaces.

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.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-tags.

AWS CLI

Para adicionar tags a um WorkSpace

O exemplo create-tags a seguir adiciona as tags especificadas ao WorkSpace especificado.

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 Marcar recursos do WorkSpaces no Guia do administrador do Amazon WorkSpaces.

  • Para obter detalhes da API, consulte CreateTags na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-workspaces.

AWS CLI

Exemplo 1: criar um WorkSpace AlwaysOn

O exemplo create-workspaces a seguir cria um WorkSpace AlwaysOn 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: criar um WorkSpace AutoStop

O exemplo create-workspaces a seguir cria um WorkSpace AutoStop 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: criar um WorkSpace desacoplado pelo usuário

O exemplo create-workspaces a seguir cria um WorkSpace desacoplado pelo usuário definindo o nome de usuário como [UNDEFINED] e especificando um nome do WorkSpace, 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 Inicializar uma área de trabalho virtual no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte CreateWorkspaces na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-tags.

AWS CLI

Para excluir uma tag de um WorkSpace

O exemplo delete-tags a seguir exclui a tag especificada do WorkSpace especificado.

aws workspaces delete-tags \
    --resource-id ws-dk1xzr417 \
    --tag-keys Department

Este comando não produz saída.

Para obter mais informações, consulte Marcar recursos do WorkSpaces no Guia do administrador do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte DeleteTags na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar deregister-workspace-directory.

AWS CLI

Como cancelar o registro de um diretório

O exemplo deregister-workspace-directory a seguir cancela o registro do diretório especificado.

aws workspaces deregister-workspace-directory \
    --directory-id d-926722edaf

Este comando não produz saída.

Para obter mais informações, consulte Registrar um diretório com o WorkSpaces no Guia de administração do Amazon WorkSpaces.

O código de exemplo a seguir mostra como usar describe-tags.

AWS CLI

Para descrever as tags de um WorkSpace

O exemplo describe-tags a seguir descreve as tags do WorkSpace especificado.

aws workspaces describe-tags \
    --resource-id ws-dk1xzr417

Saída:

{
    "TagList": [
        {
            "Key": "Department",
            "Value": "Finance"
        }
    ]
}

Para obter mais informações, consulte Marcar recursos do WorkSpaces no Guia do administrador do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte DescribeTags na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar describe-workspace-bundles.

AWS CLI

Para listar os pacotes fornecidos pela Amazon

O exemplo describe-workspace-bundles a seguir lista os nomes e IDs dos 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 Pacotes e imagens do WorkSpaces no Guia de administração do Amazon WorkSpaces.

O código de exemplo a seguir mostra como usar describe-workspace-directories.

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 ter mais informações, consulte Manage directories for WorkSpaces Personal no Guia de administração do Amazon WorkSpaces.

O código de exemplo a seguir mostra como usar describe-workspaces-connection-status.

AWS CLI

Para descrever o status da conexão de um WorkSpace

O exemplo describe-workspaces-connection-status a seguir descreve o status de conexão do WorkSpace especificado.

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 seus WorkSpaces no Guia de administração do Amazon WorkSpaces.

O código de exemplo a seguir mostra como usar describe-workspaces.

AWS CLI

Para descrever um WorkSpace

O exemplo describe-workspaces a seguir descreve o WorkSpace especificado.

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 seus WorkSpaces no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte DescribeWorkspaces na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar migrate-workspace.

AWS CLI

Como migrar um WorkSpace

O exemplo migrate-workspace a seguir migra o WorkSpace especificado para o pacote especificado.

aws workspaces migrate-workspace \
    --source-workspace-id ws-dk1xzr417 \
    --bundle-id wsb-j4dky1gs4

Saída:

{
    "SourceWorkspaceId": "ws-dk1xzr417",
    "TargetWorkspaceId": "ws-x5h1lbkp5"
}

Para obter mais informações, consulte Migrar um WorkSpace no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte MigrateWorkspace na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar modify-workspace-creation-properties.

AWS CLI

Para modificar uma propriedade de criação do WorkSpace 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 os WorkSpaces criados 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 detalhes de diretório em seu WorkSpaces no Guia de administração do Amazon WorkSpaces.

O código de exemplo a seguir mostra como usar modify-workspace-properties.

AWS CLI

Para modificar o modo de execução de um WorkSpace

O exemplo modify-workspace-properties a seguir define o modo de execução do WorkSpace especificado como 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 um WorkSpace no Guia de administração do Amazon WorkSpaces.

O código de exemplo a seguir mostra como usar modify-workspace-state.

AWS CLI

Para modificar o estado de um WorkSpace

O exemplo modify-workspace-state a seguir define o estado do WorkSpace especificado como 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 Manutenção do WorkSpace no Guia de administração do Amazon WorkSpaces.

O código de exemplo a seguir mostra como usar reboot-workspaces.

AWS CLI

Como reiniciar um WorkSpace

O exemplo reboot-workspaces a seguir reinicia o WorkSpace especificado.

aws workspaces reboot-workspaces \
    --reboot-workspace-requests ws-dk1xzr417

Saída:

{
    "FailedRequests": []
}

Para obter mais informações, consulte Reiniciar um WorkSpace no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte RebootWorkspaces na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar rebuild-workspaces.

AWS CLI

Como recriar um WorkSpace

O exemplo rebuild-workspaces a seguir reconstrói o WorkSpace especificado.

aws workspaces rebuild-workspaces \
    --rebuild-workspace-requests ws-dk1xzr417

Saída:

{
    "FailedRequests": []
}

Para obter mais informações, consulte Recriar um WorkSpace no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte RebuildWorkspaces na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar register-workspace-directory.

AWS CLI

Para registrar um diretório

O exemplo register-workspace-directory a seguir registra o diretório especificado para uso com o Amazon WorkSpaces.

aws workspaces register-workspace-directory \
    --directory-id d-926722edaf

Este comando não produz saída.

Para obter mais informações, consulte Register an existing AWS Directory Service directory with WorkSpaces Personal no Guia de administração do Amazon WorkSpaces.

O código de exemplo a seguir mostra como usar restore-workspace.

AWS CLI

Como restaurar um WorkSpace

O exemplo restore-workspace a seguir restaura o WorkSpace especificado.

aws workspaces restore-workspace \
    --workspace-id ws-dk1xzr417

Este comando não produz saída.

Para obter mais informações, consulte Restaurar um WorkSpace no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte RestoreWorkspace na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar start-workspaces.

AWS CLI

Para iniciar um WorkSpace AutoStop

O exemplo start-workspaces a seguir inicia o WorkSpace especificado. O WorkSpace deve ter um modo de execução de AutoStop.

aws workspaces start-workspaces \
    --start-workspace-requests WorkspaceId=ws-dk1xzr417

Saída:

{
    "FailedRequests": []
}

Para obter mais informações, consulte Interromper e iniciar um WorkSpace AutoStop no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte StartWorkspaces na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar stop-workspaces.

AWS CLI

Como interromper um WorkSpace AutoStop

O exemplo stop-workspaces a seguir interrompe o WorkSpace especificado. O WorkSpace deve 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 Interromper e iniciar um WorkSpace AutoStop no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte StopWorkspaces na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar terminate-workspaces.

AWS CLI

Como 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 no Guia de administração do Amazon WorkSpaces.

  • Para ver detalhes da API, consulte TerminateWorkspaces na Referência de comandos da AWS CLI.