WorkSpaces ejemplos que utilizan AWS CLI - AWS SDKEjemplos de código
Acciones

Hay más AWS SDK ejemplos disponibles en el GitHub repositorio de 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.

WorkSpaces ejemplos que utilizan AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante el uso del AWS Command Line Interface with WorkSpaces.

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 funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

En el siguiente ejemplo de código se muestra cómo usar create-tags.

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 en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte CreateTagsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar create-workspaces.

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 en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte CreateWorkspacesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar delete-tags.

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 en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte DeleteTagsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar deregister-workspace-directory.

AWS CLI

Para anular el registro de un directorio

El siguiente deregister-workspace-directory ejemplo anula el registro del directorio especificado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulta Registrar un directorio WorkSpaces en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código se muestra cómo usar describe-tags.

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 en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte DescribeTagsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar describe-workspace-bundles.

AWS CLI

Para publicar 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 en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código se muestra cómo usar describe-workspace-directories.

AWS CLI

Para describir un directorio registrado

El siguiente describe-workspace-directories ejemplo describe el directorio registrado especificado.

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": {
                "EnableWorkDocs": false,
                "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 WorkSpaces en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código se muestra cómo usar describe-workspaces-connection-status.

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 en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código se muestra cómo usar describe-workspaces.

AWS CLI

Para describir un WorkSpace

En el siguiente describe-workspaces ejemplo se 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 en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte DescribeWorkspacesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar migrate-workspace.

AWS CLI

Para migrar un WorkSpace

En el siguiente migrate-workspace ejemplo, se WorkSpace migra el paquete especificado al especificado.

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

Salida:

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

Para obtener más información, consulte Migrate a WorkSpace en la Amazon WorkSpaces Administration Guide.

  • Para API obtener más información, consulte MigrateWorkspacela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar modify-workspace-creation-properties.

AWS CLI

Para modificar una propiedad de WorkSpace creación de un directorio

El siguiente modify-workspace-creation-properties ejemplo habilita la EnableInternetAccess propiedad 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 en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código se muestra cómo usar modify-workspace-properties.

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 enAUTO_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 en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código se muestra cómo usar modify-workspace-state.

AWS CLI

Para modificar el estado de un WorkSpace

En el siguiente modify-workspace-state ejemplo, se establece el estado del especificado WorkSpace enADMIN_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 en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte ModifyWorkspaceStatela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar reboot-workspaces.

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 en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte RebootWorkspacesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar rebuild-workspaces.

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 en la Amazon WorkSpaces Administration Guide.

  • Para API obtener más información, consulte RebuildWorkspacesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar register-workspace-directory.

AWS CLI

Para registrar un directorio

En el siguiente register-workspace-directory ejemplo, se registra el directorio especificado para usarlo con Amazon WorkSpaces.

aws workspaces register-workspace-directory \
    --directory-id d-926722edaf \
    --no-enable-work-docs

Este comando no genera ninguna salida.

Para obtener más información, consulta Registrar un directorio WorkSpaces en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código se muestra cómo usar restore-workspace.

AWS CLI

Para restaurar un WorkSpace

El siguiente restore-workspace ejemplo restaura lo especificado WorkSpace.

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

Este comando no genera ninguna salida.

Para obtener más información, consulta Restaurar a WorkSpace en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte RestoreWorkspacela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar start-workspaces.

AWS CLI

Para iniciar una AutoStop WorkSpace

En el siguiente start-workspaces ejemplo, se inicia el especificado WorkSpace. WorkSpace Debe tener un modo de ejecución deAutoStop.

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

Salida:

{
    "FailedRequests": []
}

Para obtener más información, consulta Stop and start an AutoStop WorkSpace en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte StartWorkspacesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar stop-workspaces.

AWS CLI

Para detener un AutoStop WorkSpace

El siguiente stop-workspaces ejemplo detiene lo especificado WorkSpace. WorkSpace Debe tener un modo de ejecución deAutoStop.

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 en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte StopWorkspacesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código se muestra cómo usar terminate-workspaces.

AWS CLI

Para terminar un WorkSpace

En el siguiente terminate-workspaces ejemplo se termina el espacio de trabajo especificado.

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

Salida:

{
    "FailedRequests": []
}

Para obtener más información, consulta Eliminar un WorkSpace en la Guía de WorkSpaces administración de Amazon.

  • Para API obtener más información, consulte TerminateWorkspacesla Referencia de AWS CLI comandos.