D'autres exemples de AWS SDK sont disponibles dans le référentiel [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Exemples de code pour WorkSpaces l'utilisation AWS SDKs
Les exemples de code suivants vous montrent comment utiliser Amazon WorkSpaces avec un kit de développement AWS logiciel (SDK).
Les *actions* sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Alors que les actions vous indiquent comment appeler des fonctions de service individuelles, vous pouvez les voir en contexte dans leurs scénarios associés.
**Ressources supplémentaires**
+ **[ WorkSpaces Guide du développeur](https://docs.aws.amazon.com/workspaces/latest/userguide/workspaces-user-getting-started.html)** — Plus d'informations sur WorkSpaces.
+ **[WorkSpaces Référence d'API](https://docs.aws.amazon.com/workspaces/latest/api/welcome.html)** : détails sur toutes les WorkSpaces actions disponibles.
+ **[AWS Centre pour les développeurs](https://aws.amazon.com/developer/code-examples/?awsf.sdk-code-examples-product=product%23)** : exemples de code que vous pouvez filtrer par catégorie ou par recherche en texte intégral.
+ **[AWS Exemples de SDK](https://github.com/awsdocs/aws-doc-sdk-examples)** : GitHub dépôt avec code complet dans les langues préférées. Inclut des instructions sur la configuration et l’exécution du code.
**Contents**
+ [Principes de base](workspaces_code_examples_basics.md)
+ [Actions](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)
# Exemples de base pour WorkSpaces l'utilisation AWS SDKs
Les exemples de code suivants montrent comment utiliser les bases d'Amazon WorkSpaces avec AWS SDKs.
**Contents**
+ [Actions](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)
# Actions d' WorkSpaces utilisation AWS SDKs
Les exemples de code suivants montrent comment effectuer des WorkSpaces actions individuelles avec AWS SDKs. Chaque exemple inclut un lien vers GitHub, où vous pouvez trouver des instructions pour configurer et exécuter le code.
Les exemples suivants incluent uniquement les actions les plus couramment utilisées. Pour une liste complète, consultez le [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)
# Utilisation de `CreateTags` avec une CLI
Les exemples de code suivants illustrent comment utiliser `CreateTags`.
------
#### [ CLI ]
**AWS CLI**
**Pour ajouter des balises à un WorkSpace**
L'`create-tags`exemple suivant ajoute les balises spécifiées aux balises spécifiées WorkSpace.
```
aws workspaces create-tags \
--resource-id ws-dk1xzr417 \
--tags Key=Department,Value=Finance
```
Cette commande ne produit aucune sortie.
Pour plus d'informations, consultez la section [ WorkSpaces Ressources relatives aux balises](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) dans le *guide WorkSpaces d'administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [CreateTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/create-tags.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple ajoute une balise à un espace de travail nommé `ws-wsname`. La balise possède une clé de « Nom » et une valeur de clé 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
```
**Exemple 2 : cet exemple ajoute plusieurs balises à un espace de travail nommé `ws-wsname`. Une balise possède une clé « Nom » et une valeur clé de `AWS_Workspace` ; l’autre balise a une clé « Stage » et une valeur clé « 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
```
+ Pour plus de détails sur l'API, reportez-vous [CreateTags](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple ajoute une balise à un espace de travail nommé `ws-wsname`. La balise possède une clé de « Nom » et une valeur de clé 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
```
**Exemple 2 : cet exemple ajoute plusieurs balises à un espace de travail nommé `ws-wsname`. Une balise possède une clé « Nom » et une valeur clé de `AWS_Workspace` ; l’autre balise a une clé « Stage » et une valeur clé « 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
```
+ Pour plus de détails sur l'API, reportez-vous [CreateTags](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `CreateWorkspaces` avec une CLI
Les exemples de code suivants illustrent comment utiliser `CreateWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Exemple 1 : pour créer un AlwaysOn WorkSpace**
L'`create-workspaces`exemple suivant crée un AlwaysOn WorkSpace pour l'utilisateur spécifié, en utilisant le répertoire et le bundle spécifiés.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName=Mateo,BundleId=wsb-0zsvgp8fc
```
Sortie :
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-kcqms853t",
"DirectoryId": "d-926722edaf",
"UserName": "Mateo",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc"
}
]
}
```
**Exemple 2 : pour créer un AutoStop WorkSpace**
L'`create-workspaces`exemple suivant crée un AutoStop WorkSpace pour l'utilisateur spécifié, en utilisant le répertoire et le bundle spécifiés.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName=Mary,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=AUTO_STOP}
```
Sortie :
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-dk1xzr417",
"DirectoryId": "d-926722edaf",
"UserName": "Mary",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc"
}
]
}
```
**Exemple 3 : pour créer un système découplé par l'utilisateur WorkSpace**
L'`create-workspaces`exemple suivant crée un découplage utilisateur WorkSpace en définissant le nom d'utilisateur sur et en spécifiant un WorkSpace nom`[UNDEFINED]`, un ID de répertoire et un ID de bundle.
```
aws workspaces create-workspaces \
--workspaces DirectoryId=d-926722edaf,UserName='"[UNDEFINED]"',WorkspaceName=MaryWorkspace1,BundleId=wsb-0zsvgp8fc,WorkspaceProperties={RunningMode=ALWAYS_ON}
```
Sortie :
```
{
"FailedRequests": [],
"PendingRequests": [
{
"WorkspaceId": "ws-abcd1234",
"DirectoryId": "d-926722edaf",
"UserName": "[UNDEFINED]",
"State": "PENDING",
"BundleId": "wsb-0zsvgp8fc",
"WorkspaceName": "MaryWorkspace1"
}
]
}
```
Pour plus d'informations, consultez la section [Lancer un bureau virtuel](https://docs.aws.amazon.com/workspaces/latest/adminguide/launch-workspaces-tutorials.html) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [CreateWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/create-workspaces.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : créez un WorkSpace pour le bundle, le répertoire et l'utilisateur fournis.**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**Exemple 2 : Cet exemple crée plusieurs WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ Pour plus de détails sur l'API, reportez-vous [CreateWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : créez un WorkSpace pour le bundle, le répertoire et l'utilisateur fournis.**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME"}
```
**Exemple 2 : Cet exemple crée plusieurs WorkSpaces**
```
New-WKSWorkspace -Workspace @{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_1"},@{"BundleID" = "wsb-1a2b3c4d"; "DirectoryId" = "d-1a2b3c4d"; "UserName" = "USERNAME_2"}
```
+ Pour plus de détails sur l'API, reportez-vous [CreateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DeleteTags` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DeleteTags`.
------
#### [ CLI ]
**AWS CLI**
**Pour supprimer un tag d'un WorkSpace**
L'`delete-tags`exemple suivant supprime la balise spécifiée de la balise spécifiée WorkSpace.
```
aws workspaces delete-tags \
--resource-id ws-dk1xzr417 \
--tag-keys Department
```
Cette commande ne produit aucune sortie.
Pour plus d'informations, consultez la section [ WorkSpaces Ressources relatives aux balises](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) dans le *guide WorkSpaces d'administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [DeleteTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/delete-tags.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple supprime la balise associée à l’espace de travail**
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**Sortie** :
```
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
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteTags](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple supprime la balise associée à l’espace de travail**
```
Remove-WKSTag -ResourceId ws-w10b3abcd -TagKey "Type"
```
**Sortie** :
```
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
```
+ Pour plus de détails sur l'API, reportez-vous [DeleteTags](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeTags` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeTags`.
------
#### [ CLI ]
**AWS CLI**
**Pour décrire les balises d'un WorkSpace**
L'`describe-tags`exemple suivant décrit les balises pour le paramètre spécifié WorkSpace.
```
aws workspaces describe-tags \
--resource-id ws-dk1xzr417
```
Sortie :
```
{
"TagList": [
{
"Key": "Department",
"Value": "Finance"
}
]
}
```
Pour plus d'informations, consultez la section [ WorkSpaces Ressources relatives aux balises](https://docs.aws.amazon.com/workspaces/latest/adminguide/tag-workspaces-resources.html) dans le *guide WorkSpaces d'administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeTags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-tags.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple récupère la balise pour l’espace de travail donné**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**Sortie** :
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeTags](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple récupère la balise pour l’espace de travail donné**
```
Get-WKSTag -WorkspaceId ws-w361s234r -Region us-west-2
```
**Sortie** :
```
Key Value
--- -----
auto-delete no
purpose Workbench
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeTags](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeWorkspaceBundles` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeWorkspaceBundles`.
------
#### [ CLI ]
**AWS CLI**
**Pour répertorier les offres proposées par Amazon**
L'`describe-workspace-bundles`exemple suivant répertorie les noms et IDs les offres groupées fournis par Amazon, sous forme de tableau et triés par nom.
```
aws workspaces describe-workspace-bundles \
--owner AMAZON \
--query "Bundles[*].[Name, BundleId]"
```
Sortie :
```
[
[
"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"
],
...
]
```
Pour plus d'informations, consultez [WorkSpaces les offres groupées et les images](https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-bundles.html) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaceBundles](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspace-bundles.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple récupère les détails de toutes les offres de l’espace de travail dans la région actuelle**
```
Get-WKSWorkspaceBundle
```
**Sortie** :
```
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
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple récupère les détails de toutes les offres de l’espace de travail dans la région actuelle**
```
Get-WKSWorkspaceBundle
```
**Sortie** :
```
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
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaceBundles](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeWorkspaceDirectories` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeWorkspaceDirectories`.
------
#### [ CLI ]
**AWS CLI**
**Pour décrire un répertoire enregistré**
L’exemple `describe-workspace-directories` suivant décrit le répertoire enregistré spécifié.
```
aws workspaces describe-workspace-directories \
--directory-ids d-926722edaf
```
Sortie :
```
{
"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"
}
}
]
}
```
Pour plus d'informations, consultez la section [Gérer les annuaires pour les WorkSpaces particuliers](https://docs.aws.amazon.com/workspaces/latest/adminguide/manage-workspaces-directory.html) dans le *guide WorkSpaces d'administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaceDirectories](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspace-directories.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple répertorie les détails des répertoires enregistrés**
```
Get-WKSWorkspaceDirectory
```
**Sortie** :
```
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
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple répertorie les détails des répertoires enregistrés**
```
Get-WKSWorkspaceDirectory
```
**Sortie** :
```
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
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaceDirectories](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeWorkspaces` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Pour décrire un WorkSpace**
L'`describe-workspaces`exemple suivant décrit ce qui est spécifié WorkSpace.
```
aws workspaces describe-workspaces \
--workspace-ids ws-dk1xzr417
```
Sortie :
```
{
"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": []
}
]
}
```
Pour plus d'informations, consultez la section [Administrer votre WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html) dans le *guide WorkSpaces d'administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : récupère les détails de toutes vos connexions WorkSpaces au pipeline.**
```
Get-WKSWorkspace
```
**Sortie** :
```
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
```
**Exemple 2 : cette commande affiche les valeurs des propriétés enfant de `WorkSpaceProperties` pour un espace de travail dans la région `us-west-2`. Pour plus d'informations sur les propriétés enfant de`WorkSpaceProperties`, consultez https://docs.aws.amazon.com/workspaces/ latest/api/API \$1 WorkspaceProperties .html.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties
```
**Sortie** :
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**Exemple 3 : cette commande indique la valeur de la propriété enfant `RootVolumeSizeGib` de `WorkSpaceProperties` pour un espace de travail dans la région `us-west-2`. La taille du volume racine, en GiO, est de 80.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**Sortie** :
```
80
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : récupère les détails de toutes vos connexions WorkSpaces au pipeline.**
```
Get-WKSWorkspace
```
**Sortie** :
```
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
```
**Exemple 2 : cette commande affiche les valeurs des propriétés enfant de `WorkSpaceProperties` pour un espace de travail dans la région `us-west-2`. Pour plus d'informations sur les propriétés enfant de`WorkSpaceProperties`, consultez https://docs.aws.amazon.com/workspaces/ latest/api/API \$1 WorkspaceProperties .html.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties
```
**Sortie** :
```
ComputeTypeName : STANDARD
RootVolumeSizeGib : 80
RunningMode : AUTO_STOP
RunningModeAutoStopTimeoutInMinutes : 60
UserVolumeSizeGib : 50
```
**Exemple 3 : cette commande indique la valeur de la propriété enfant `RootVolumeSizeGib` de `WorkSpaceProperties` pour un espace de travail dans la région `us-west-2`. La taille du volume racine, en GiO, est de 80.**
```
(Get-WKSWorkspace -Region us-west-2 -WorkSpaceId ws-xdaf7hc9s).WorkspaceProperties.RootVolumeSizeGib
```
**Sortie** :
```
80
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `DescribeWorkspacesConnectionStatus` avec une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeWorkspacesConnectionStatus`.
------
#### [ CLI ]
**AWS CLI**
**Pour décrire l'état de connexion d'un WorkSpace**
L'`describe-workspaces-connection-status`exemple suivant décrit l'état de connexion du paramètre spécifié WorkSpace.
```
aws workspaces describe-workspaces-connection-status \
--workspace-ids ws-dk1xzr417
```
Sortie :
```
{
"WorkspacesConnectionStatus": [
{
"WorkspaceId": "ws-dk1xzr417",
"ConnectionState": "CONNECTED",
"ConnectionStateCheckTimestamp": 1662526214.744
}
]
}
```
Pour plus d'informations, consultez la section [Administrer votre WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/administer-workspaces.html) dans le *guide WorkSpaces d'administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspacesConnectionStatus](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/describe-workspaces-connection-status.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple récupère le statut de la connexion pour l’espace de travail spécifié**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple récupère le statut de la connexion pour l’espace de travail spécifié**
```
Get-WKSWorkspacesConnectionStatus -WorkspaceId ws-w123s234r
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeWorkspacesConnectionStatus](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `ModifyWorkspaceCreationProperties` avec une CLI
Les exemples de code suivants illustrent comment utiliser `ModifyWorkspaceCreationProperties`.
------
#### [ CLI ]
**AWS CLI**
**Pour modifier une propriété de WorkSpace création d'un répertoire**
L’exemple `modify-workspace-creation-properties` suivant active la propriété `EnableInternetAccess` pour le répertoire spécifié. Cela permet l'attribution automatique d'adresses IP publiques pour les adresses IP WorkSpaces créées pour l'annuaire.
```
aws workspaces modify-workspace-creation-properties \
--resource-id d-926722edaf \
--workspace-creation-properties EnableInternetAccess=true
```
Cette commande ne produit aucune sortie.
Pour plus d'informations, consultez la section [Mettre à jour les informations de votre répertoire WorkSpaces](https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html) dans le *guide WorkSpaces d'administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceCreationProperties](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-creation-properties.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple active l’accès à Internet et le mode de maintenance sur true comme valeurs par défaut lors de la création d’un espace de travail**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple active l’accès à Internet et le mode de maintenance sur true comme valeurs par défaut lors de la création d’un espace de travail**
```
Edit-WKSWorkspaceCreationProperty -Region us-west-2 -ResourceId d-123454a369 -WorkspaceCreationProperties_EnableInternetAccess $true -WorkspaceCreationProperties_EnableMaintenanceMode $true
```
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceCreationProperties](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `ModifyWorkspaceProperties` avec une CLI
Les exemples de code suivants illustrent comment utiliser `ModifyWorkspaceProperties`.
------
#### [ CLI ]
**AWS CLI**
**Pour modifier le mode de fonctionnement d'un WorkSpace**
L'`modify-workspace-properties`exemple suivant définit le mode d'exécution du paramètre spécifié WorkSpace sur`AUTO_STOP`.
```
aws workspaces modify-workspace-properties \
--workspace-id ws-dk1xzr417 \
--workspace-properties RunningMode=AUTO_STOP
```
Cette commande ne produit aucune sortie.
Pour plus d'informations, consultez [Modifier un WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceProperties](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-properties.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple modifie la propriété Workspace Running Mode sur Auto Stop pour l’espace de travail spécifié**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple modifie la propriété Workspace Running Mode sur Auto Stop pour l’espace de travail spécifié**
```
Edit-WKSWorkspaceProperty -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceProperties_RunningMode AUTO_STOP
```
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceProperties](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `ModifyWorkspaceState` avec une CLI
Les exemples de code suivants illustrent comment utiliser `ModifyWorkspaceState`.
------
#### [ CLI ]
**AWS CLI**
**Pour modifier l'état d'un WorkSpace**
L'`modify-workspace-state`exemple suivant définit l'état de la valeur spécifiée WorkSpace sur`ADMIN_MAINTENANCE`.
```
aws workspaces modify-workspace-state \
--workspace-id ws-dk1xzr417 \
--workspace-state ADMIN_MAINTENANCE
```
Cette commande ne produit aucune sortie.
Pour plus d'informations, consultez la section [WorkSpace maintenance](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceState](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/modify-workspace-state.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple fait passer l’état de l’espace de travail spécifié sur Disponible**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple fait passer l’état de l’espace de travail spécifié sur Disponible**
```
Edit-WKSWorkspaceState -WorkspaceId ws-w361s100v -Region us-west-2 -WorkspaceState AVAILABLE
```
+ Pour plus de détails sur l'API, reportez-vous [ModifyWorkspaceState](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `RebootWorkspaces` avec une CLI
Les exemples de code suivants illustrent comment utiliser `RebootWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Pour redémarrer un WorkSpace**
L'`reboot-workspaces`exemple suivant redémarre le fichier spécifié WorkSpace.
```
aws workspaces reboot-workspaces \
--reboot-workspace-requests ws-dk1xzr417
```
Sortie :
```
{
"FailedRequests": []
}
```
Pour plus d'informations, consultez [Reboot a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/reboot-workspaces.html) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [RebootWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/reboot-workspaces.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : redémarre le paramètre spécifié WorkSpace.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemple 2 : redémarre plusieurs WorkSpaces fois.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**Exemple 3 : récupère la collection de tous vos fichiers WorkSpaces et les redirige IDs vers le WorkSpaceId paramètre - de Restart-WKSWorkspace, provoquant le WorkSpaces redémarrage du.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ Pour plus de détails sur l'API, reportez-vous [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : redémarre le paramètre spécifié WorkSpace.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemple 2 : redémarre plusieurs WorkSpaces fois.**
```
Restart-WKSWorkspace -WorkspaceId "ws-1a2b3c4d","ws-5a6b7c8d"
```
**Exemple 3 : récupère la collection de tous vos fichiers WorkSpaces et les redirige IDs vers le WorkSpaceId paramètre - de Restart-WKSWorkspace, provoquant le WorkSpaces redémarrage du.**
```
Get-WKSWorkspaces | Restart-WKSWorkspace
```
+ Pour plus de détails sur l'API, reportez-vous [RebootWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `RebuildWorkspaces` avec une CLI
Les exemples de code suivants illustrent comment utiliser `RebuildWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Pour reconstruire un WorkSpace**
L'`rebuild-workspaces`exemple suivant reconstruit le fichier spécifié WorkSpace.
```
aws workspaces rebuild-workspaces \
--rebuild-workspace-requests ws-dk1xzr417
```
Sortie :
```
{
"FailedRequests": []
}
```
Pour plus d'informations, consultez [Rebuild a WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/rebuild-workspace.html) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [RebuildWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/rebuild-workspaces.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : reconstruit le fichier spécifié WorkSpace.**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemple 2 : récupère la collection de tous vos fichiers WorkSpaces et les redirige IDs vers le WorkSpaceId paramètre - de Reset-WKSWorkspace, ce qui entraîne WorkSpaces leur reconstruction.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ Pour plus de détails sur l'API, reportez-vous [RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : reconstruit le fichier spécifié WorkSpace.**
```
Reset-WKSWorkspace -WorkspaceId "ws-1a2b3c4d"
```
**Exemple 2 : récupère la collection de tous vos fichiers WorkSpaces et les redirige IDs vers le WorkSpaceId paramètre - de Reset-WKSWorkspace, ce qui entraîne WorkSpaces leur reconstruction.**
```
Get-WKSWorkspaces | Reset-WKSWorkspace
```
+ Pour plus de détails sur l'API, reportez-vous [RebuildWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `RegisterWorkspaceDirectory` avec une CLI
Les exemples de code suivants illustrent comment utiliser `RegisterWorkspaceDirectory`.
------
#### [ CLI ]
**AWS CLI**
**Pour enregistrer un répertoire**
L'`register-workspace-directory`exemple suivant enregistre le répertoire spécifié pour une utilisation avec Amazon WorkSpaces.
```
aws workspaces register-workspace-directory \
--directory-id d-926722edaf
```
Cette commande ne produit aucune sortie.
Pour plus d'informations, consultez la section [Enregistrer un AWS annuaire Directory Service existant auprès de WorkSpaces Personal](https://docs.aws.amazon.com/workspaces/latest/adminguide/register-deregister-directory.html) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [RegisterWorkspaceDirectory](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/register-workspace-directory.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : cet exemple enregistre le répertoire spécifié pour le service Workspaces**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ Pour plus de détails sur l'API, reportez-vous [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : cet exemple enregistre le répertoire spécifié pour le service Workspaces**
```
Register-WKSWorkspaceDirectory -DirectoryId d-123412a123 -EnableWorkDoc $false
```
+ Pour plus de détails sur l'API, reportez-vous [RegisterWorkspaceDirectory](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `StopWorkspaces` avec une CLI
Les exemples de code suivants illustrent comment utiliser `StopWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Pour arrêter un AutoStop WorkSpace**
L'`stop-workspaces`exemple suivant arrête le paramètre spécifié WorkSpace. Le mode de fonctionnement WorkSpace doit être de`AutoStop`.
```
aws workspaces stop-workspaces \
--stop-workspace-requests WorkspaceId=ws-dk1xzr417
```
Sortie :
```
{
"FailedRequests": []
}
```
Pour plus d'informations, consultez la section [Stop and start an AutoStop WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html#stop-start-workspace) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [StopWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/stop-workspaces.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : arrête plusieurs WorkSpaces**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**Exemple 2 : récupère la collection de tous vos WorkSpaces fichiers et les dirige IDs vers le WorkSpaceId paramètre - de Stop- WKSWorkspace provoquant WorkSpaces leur arrêt.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**Exemple 3 : Cet exemple montre comment transmettre StopRequest des objets définissant le WorkSpaces à arrêter.**
```
$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
```
+ Pour plus de détails sur l'API, reportez-vous [StopWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : arrête plusieurs WorkSpaces**
```
Stop-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0"
```
**Exemple 2 : récupère la collection de tous vos WorkSpaces fichiers et les dirige IDs vers le WorkSpaceId paramètre - de Stop- WKSWorkspace provoquant WorkSpaces leur arrêt.**
```
Get-WKSWorkspaces | Stop-WKSWorkspace
```
**Exemple 3 : Cet exemple montre comment transmettre StopRequest des objets définissant le WorkSpaces à arrêter.**
```
$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
```
+ Pour plus de détails sur l'API, reportez-vous [StopWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------
# Utilisation de `TerminateWorkspaces` avec une CLI
Les exemples de code suivants illustrent comment utiliser `TerminateWorkspaces`.
------
#### [ CLI ]
**AWS CLI**
**Pour mettre fin à un WorkSpace**
L’exemple `terminate-workspaces` suivant résilie l’instance WorkSpace spécifiée.
```
aws workspaces terminate-workspaces \
--terminate-workspace-requests ws-dk1xzr417
```
Sortie :
```
{
"FailedRequests": []
}
```
Pour plus d'informations, consultez [Supprimer un WorkSpace](https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces.html) dans le *guide d' WorkSpaces administration Amazon*.
+ Pour plus de détails sur l'API, reportez-vous [TerminateWorkspaces](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/workspaces/terminate-workspaces.html)à la section *Référence des AWS CLI commandes*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : met fin à plusieurs WorkSpaces. L'utilisation du commutateur -Force empêche l'applet de commande de demander une confirmation.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**Exemple 2 : Récupère la collection de tous vos WorkSpaces et les dirige IDs vers le WorkSpaceId paramètre - de Remove-WKSWorkspace, en mettant fin à tous les. WorkSpaces L'applet de commande affiche un message avant de terminer chacune d'entre elles WorkSpace . Pour supprimer l’invite de confirmation, ajoutez le commutateur -Force.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**Exemple 3 : Cet exemple montre comment transmettre TerminateRequest des objets définissant le WorkSpaces à terminer. L’applet de commande vous invitera à confirmer avant de poursuivre, à moins que l’option -Force ne soit spécifiée.**
```
$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
```
+ Pour plus de détails sur l'API, reportez-vous [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
**Outils pour PowerShell V5**
**Exemple 1 : met fin à plusieurs WorkSpaces. L'utilisation du commutateur -Force empêche l'applet de commande de demander une confirmation.**
```
Remove-WKSWorkspace -WorkspaceId "ws-1a2b3c4d5","ws-6a7b8c9d0" -Force
```
**Exemple 2 : Récupère la collection de tous vos WorkSpaces et les dirige IDs vers le WorkSpaceId paramètre - de Remove-WKSWorkspace, en mettant fin à tous les. WorkSpaces L'applet de commande affiche un message avant de terminer chacune d'entre elles WorkSpace . Pour supprimer l’invite de confirmation, ajoutez le commutateur -Force.**
```
Get-WKSWorkspaces | Remove-WKSWorkspace
```
**Exemple 3 : Cet exemple montre comment transmettre TerminateRequest des objets définissant le WorkSpaces à terminer. L’applet de commande vous invitera à confirmer avant de poursuivre, à moins que l’option -Force ne soit spécifiée.**
```
$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
```
+ Pour plus de détails sur l'API, reportez-vous [TerminateWorkspaces](https://docs.aws.amazon.com/powershell/v5/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V5)*.
------