View a markdown version of this page

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

Hay más ejemplos de AWS SDK disponibles en el repositorio de ejemplos de AWS Doc SDK. GitHub

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

En cada ejemplo se incluye un enlace al código de origen completo, con instrucciones de configuración y ejecución del código en el contexto.

Acciones

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

AWS CLI

Para añadir etiquetas a un WorkSpace

El siguiente create-tags ejemplo agrega 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, consulte WorkSpaces los recursos de etiquetas en la Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte CreateTags la sección de referencia de AWS CLI comandos.

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

AWS CLI

Ejemplo 1: Para crear un AlwaysOn WorkSpace

El siguiente create-workspaces ejemplo crea un 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

El siguiente create-workspaces ejemplo crea un 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 usuario desacoplado WorkSpace

En el siguiente create-workspaces ejemplo, se crea un usuario WorkSpace desacoplado 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 obtener más información sobre la API, consulte CreateWorkspaces la sección de referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar 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, consulte WorkSpaces los recursos sobre etiquetas en la Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte DeleteTags la sección de referencia de AWS CLI comandos.

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

AWS CLI

Para anular el registro de un directorio

En el siguiente ejemplo de deregister-workspace-directory se anula el registro del directorio indicado.

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

Este comando no genera ninguna salida.

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

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

AWS CLI

Para describir las etiquetas de un WorkSpace

El siguiente describe-tags ejemplo describe las etiquetas de lo especificado WorkSpace.

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

Salida:

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

Para obtener más información, consulte WorkSpaces los recursos de etiquetas en la Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte DescribeTags la sección de referencia de AWS CLI comandos.

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

AWS CLI

Para enumerar los paquetes proporcionados por Amazon

En el siguiente ejemplo de describe-workspace-bundles, se muestran los nombres e ID de 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, consulte los WorkSpaces paquetes y las imágenes en la Guía de administración de Amazon. WorkSpaces

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

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

En el siguiente ejemplo de código, se muestra cómo utilizar 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, consulte Administra tu empresa WorkSpaces en la Guía de WorkSpaces administración de Amazon.

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

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

  • Para obtener más información sobre la API, consulte DescribeWorkspaces la sección de referencia de AWS CLI comandos.

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

AWS CLI

Para migrar un WorkSpace

El siguiente migrate-workspace ejemplo migra el paquete especificado WorkSpace 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 Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte MigrateWorkspace la referencia de AWS CLI comandos.

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

AWS CLI

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

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, consulte Actualizar los detalles de su directorio WorkSpaces en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código, se muestra cómo utilizar 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, consulte Modificar a WorkSpace en la Guía de WorkSpaces administración de Amazon.

En el siguiente ejemplo de código, se muestra cómo utilizar 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, consulte el WorkSpace mantenimiento en la Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte ModifyWorkspaceState la sección de referencia de AWS CLI comandos.

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

AWS CLI

Para reiniciar un WorkSpace

El siguiente reboot-workspaces ejemplo reinicia lo especificado WorkSpace.

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

Salida:

{
    "FailedRequests": []
}

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

  • Para obtener más información sobre la API, consulte RebootWorkspaces la referencia de AWS CLI comandos.

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

AWS CLI

Para reconstruir un WorkSpace

El siguiente rebuild-workspaces ejemplo 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 Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte RebuildWorkspaces la referencia de AWS CLI comandos.

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

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

En el siguiente ejemplo de código, se muestra cómo utilizar 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, consulte Restore a WorkSpace en la Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte RestoreWorkspace la sección de referencia de AWS CLI comandos.

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

AWS CLI

Para iniciar un AutoStop WorkSpace

En el siguiente start-workspaces ejemplo, se inicia lo 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, consulte Detener e iniciar una AutoStop WorkSpace en la Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte StartWorkspaces la referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo utilizar 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, consulte Detener e iniciar una AutoStop WorkSpace en la Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte StopWorkspaces la referencia de AWS CLI comandos.

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

AWS CLI

Para terminar 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, consulte Eliminar a WorkSpace en la Guía de WorkSpaces administración de Amazon.

  • Para obtener más información sobre la API, consulte TerminateWorkspaces la sección de referencia de AWS CLI comandos.