Exemples d’utilisation de l’AWS CLI avec WorkDocs

Les exemples de code suivants montrent comment réaliser des actions et mettre en œuvre des scénarios courants en utilisant l’AWS Command Line Interface avec WorkDocs.

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.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la configuration et l’exécution du code en contexte.

Rubriques

Actions

Actions

L’exemple de code suivant montre comment utiliser abort-document-version-upload.

AWS CLI

Pour arrêter le chargement de la version d’un document

Cet exemple arrête le chargement d’une version de document déjà lancé.

Commande :


aws workdocs abort-document-version-upload --document-id feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2 --version-id 1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313

Sortie :


None

Pour plus de détails sur l’API, consultez AbortDocumentVersionUpload dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser activate-user.

AWS CLI

Pour activer un utilisateur

Cet exemple active un utilisateur inactif.

Commande :


aws workdocs activate-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"

Sortie :


{
  "User": {
      "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "Username": "exampleUser",
      "EmailAddress": "exampleUser@site.awsapps.com",
      "GivenName": "Example",
      "Surname": "User",
      "OrganizationId": "d-926726012c",
      "RootFolderId": "75f67c183aa1217409ac87576a45c03a5df5e6d8c51c35c01669970538e86cd0",
      "RecycleBinFolderId": "642b7dd3e60b14204534f3df7b1959e01b5d170f8c2707f410e40a8149120a57",
      "Status": "ACTIVE",
      "Type": "MINIMALUSER",
      "CreatedTimestamp": 1521226107.747,
      "ModifiedTimestamp": 1525297406.462,
      "Storage": {
          "StorageUtilizedInBytes": 0,
          "StorageRule": {
              "StorageAllocatedInBytes": 0,
              "StorageType": "QUOTA"
          }
      }
  }
}

Pour plus de détails sur l’API, consultez ActivateUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser add-resource-permissions.

AWS CLI

Pour ajouter des autorisations pour une ressource

Cet exemple ajoute des autorisations à la ressource pour les principaux spécifiés.

Commande :


aws workdocs add-resource-permissions --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --principals Id=anonymous,Type=ANONYMOUS,Role=VIEWER

Sortie :


{
  "ShareResults": [
      {
          "PrincipalId": "anonymous",
          "Role": "VIEWER",
          "Status": "SUCCESS",
          "ShareId": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
          "StatusMessage": ""
      }
  ]
}

Pour plus de détails sur l’API, consultez AddResourcePermissions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-comment.

AWS CLI

Pour ajouter un nouveau commentaire

Cet exemple ajoute un nouveau commentaire à la version de document spécifiée.

Commande :


aws workdocs create-comment --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --text "This is a comment."

Sortie :


{
  "Comment": {
      "CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
      "ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
      "Text": "This is a comment.",
      "Contributor": {
          "Id": "arn:aws:iam::123456789123:user/exampleUser",
          "Username": "exampleUser",
          "GivenName": "Example",
          "Surname": "User",
          "Status": "ACTIVE"
      },
      "CreatedTimestamp": 1534799058.197,
      "Status": "PUBLISHED",
      "Visibility": "PUBLIC"
  }
}

Pour plus de détails sur l’API, consultez CreateComment dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-custom-metadata.

AWS CLI

Pour créer des métadonnées personnalisées

Cet exemple crée des métadonnées personnalisées pour le document spécifié.

Commande :


aws workdocs create-custom-metadata --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --custom-metadata KeyName1=example,KeyName2=example2

Sortie :


None

Pour plus de détails sur l’API, consultez CreateCustomMetadata dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-folder.

AWS CLI

Pour créer un dossier

Cet exemple crée un dossier.

Commande :


aws workdocs create-folder --name documents --parent-folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678

Sortie :


{
  "Metadata": {
      "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
      "Name": "documents",
      "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
      "CreatedTimestamp": 1534450467.622,
      "ModifiedTimestamp": 1534450467.622,
      "ResourceState": "ACTIVE",
      "Signature": "",
      "Size": 0,
      "LatestVersionSize": 0
  }
}

Pour plus de détails sur l’API, consultez CreateFolder dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-labels.

AWS CLI

Pour créer des étiquettes

Cet exemple crée une série d’étiquettes pour un document.

Commande :


aws workdocs create-labels --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --labels "documents" "examples" "my_documents"

Sortie :


None

Pour plus de détails sur l’API, consultez CreateLabels dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-notification-subscription.

AWS CLI

Pour créer un abonnement aux notifications

L’exemple create-notification-subscription suivant configure un abonnement aux notifications pour l’organisation Amazon WorkDocs spécifiée.


aws workdocs create-notification-subscription \
    --organization-id d-123456789c \
    --protocol HTTPS \
    --subscription-type ALL \
    --notification-endpoint "https://example.com/example"

Sortie :


{
    "Subscription": {
        "SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123",
        "EndPoint": "https://example.com/example",
        "Protocol": "HTTPS"
    }
}

Pour plus d’informations, consultez S’abonner aux notifications dans le Manuel du développeur Amazon WorkDocs.

Pour plus de détails sur l’API, consultez CreateNotificationSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser create-user.

AWS CLI

Pour créer un nouvel utilisateur

Cet exemple crée un nouvel utilisateur dans un annuaire Simple AD ou Microsoft AD.

Commande :


aws workdocs create-user --organization-id d-926726012c --username exampleUser2 --email-address exampleUser2@site.awsapps.com --given-name example2Name --surname example2Surname --password examplePa$$w0rd

Sortie :


{
  "User": {
      "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "Username": "exampleUser2",
      "EmailAddress": "exampleUser2@site.awsapps.com",
      "GivenName": "example2Name",
      "Surname": "example2Surname",
      "OrganizationId": "d-926726012c",
      "RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390",
      "RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff",
      "Status": "ACTIVE",
      "Type": "MINIMALUSER",
      "CreatedTimestamp": 1535478836.584,
      "ModifiedTimestamp": 1535478836.584,
      "Storage": {
          "StorageUtilizedInBytes": 0,
          "StorageRule": {
              "StorageAllocatedInBytes": 0,
              "StorageType": "QUOTA"
          }
      }
  }
}

Pour plus de détails sur l’API, consultez CreateUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser deactivate-user.

AWS CLI

Pour désactiver un utilisateur

Cet exemple désactive un utilisateur actif.

Commande :


aws workdocs deactivate-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"

Sortie :


None

Pour plus de détails sur l’API, consultez DeactivateUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-comment.

AWS CLI

Pour supprimer un commentaire spécifié d’une version de document

Cet exemple supprime le commentaire spécifié de la version de document spécifiée.

Commande :


aws workdocs delete-comment --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --comment-id 1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5

Sortie :


None

Pour plus de détails sur l’API, consultez DeleteComment dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-custom-metadata.

AWS CLI

Pour supprimer des métadonnées personnalisées d’une ressource

Cet exemple supprime toutes les métadonnées personnalisées de la ressource spécifiée.

Commande :


aws workdocs delete-custom-metadata --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --delete-all

Sortie :


None

Pour plus de détails sur l’API, consultez DeleteCustomMetadata dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-document.

AWS CLI

Pour supprimer un document

Cet exemple supprime le document spécifié.

Commande :


aws workdocs delete-document --document-id b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a

Sortie :


None

Pour plus de détails sur l’API, consultez DeleteDocument dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-folder-contents.

AWS CLI

Pour supprimer le contenu d’un dossier

Cet exemple supprime le contenu du dossier spécifié.

Commande :


aws workdocs delete-folder-contents --folder-id 26fa8aa4ba2071447c194f7b150b07149dbdb9e1c8a301872dcd93a4735ce65d

Sortie :


None

Pour plus de détails sur l’API, consultez DeleteFolderContents dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-folder.

AWS CLI

Pour supprimer un dossier

Cet exemple supprime le dossier spécifié.

Commande :


aws workdocs delete-folder --folder-id 26fa8aa4ba2071447c194f7b150b07149dbdb9e1c8a301872dcd93a4735ce65d

Sortie :


None

Pour plus de détails sur l’API, consultez DeleteFolder dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-labels.

AWS CLI

Pour supprimer des étiquettes

Cet exemple supprime les étiquettes spécifiées d’un document.

Commande :


aws workdocs delete-labels --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --labels "documents" "examples"

Sortie :


None

Pour plus de détails sur l’API, consultez DeleteLabels dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-notification-subscription.

AWS CLI

Pour supprimer un abonnement aux notifications

L’exemple delete-notification-subscription suivant supprime l’abonnement aux notifications spécifié.


aws workdocs delete-notification-subscription \
    --subscription-id 123ab4c5-678d-901e-f23g-45h6789j0123 \
    --organization-id d-123456789c

Cette commande ne produit aucune sortie.

Pour plus d’informations, consultez S’abonner aux notifications dans le Manuel du développeur Amazon WorkDocs.

Pour plus de détails sur l’API, consultez DeleteNotificationSubscription dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser delete-user.

AWS CLI

Pour supprimer un utilisateur

Cet exemple supprime un utilisateur.

Commande :


aws workdocs delete-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"

Sortie :


None

Pour plus de détails sur l’API, consultez DeleteUser dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-activities.

AWS CLI

Pour obtenir une liste des activités des utilisateurs

Cet exemple renvoie une liste des dernières activités des utilisateurs pour l’organisation spécifiée, avec une limite définie pour les deux dernières activités.

Commande :


aws workdocs describe-activities --organization-id d-926726012c --limit 2

Sortie :


{
  "UserActivities": [
      {
          "Type": "DOCUMENT_VERSION_DOWNLOADED",
          "TimeStamp": 1534800122.17,
          "Initiator": {
              "Id": "arn:aws:iam::123456789123:user/exampleUser"
          },
          "ResourceMetadata": {
              "Type": "document",
              "Name": "updatedDoc",
              "Id": "15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3",
              "Owner": {
                  "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
                  "GivenName": "exampleName",
                  "Surname": "exampleSurname"
              }
          }
      },
      {
          "Type": "DOCUMENT_VERSION_VIEWED",
          "TimeStamp": 1534799079.207,
          "Initiator": {
              "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
              "GivenName": "exampleName",
              "Surname": "exampleSurname"
          },
          "ResourceMetadata": {
              "Type": "document",
              "Name": "updatedDoc",
              "Id": "15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3",
              "Owner": {
                  "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
                  "GivenName": "exampleName",
                  "Surname": "exampleSurname"
              }
          }
      }
  ],
  "Marker": "DnF1ZXJ5VGhlbkZldGNoAgAAAAAAAAS7FmlTaU1OdlFTU1h1UU00VVFIbDlRWHcAAAAAAAAJTRY3bWh5eUgzaVF1ZXN2RUE5Wm8tTTdR"
}

Pour plus de détails sur l’API, consultez DescribeActivities dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-comments.

AWS CLI

Pour répertorier tous les commentaires pour la version de document spécifiée

Cet exemple répertorie tous les commentaires pour la version de document spécifiée.

Commande :


aws workdocs describe-comments --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920

Sortie :


{
  "Comments": [
      {
          "CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
          "ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5",
          "Text": "This is a comment.",
          "Contributor": {
              "Username": "arn:aws:iam::123456789123:user/exampleUser",
              "Type": "USER"
          },
          "CreatedTimestamp": 1534799058.197,
          "Status": "PUBLISHED",
          "Visibility": "PUBLIC"
      }
  ]
}

Pour plus de détails sur l’API, consultez DescribeComments dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-document-versions.

AWS CLI

Pour récupérer les versions d’un document

Cet exemple extrait les versions du document spécifié, y compris les versions initialisées et l’URL du document source.

Commande :


aws workdocs describe-document-versions --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --fields SOURCE

Sortie :


{
  "DocumentVersions": [
      {
          "Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef",
          "Name": "exampleDoc.docx",
          "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
          "Size": 13922,
          "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
          "Status": "ACTIVE",
          "CreatedTimestamp": 1534452029.587,
          "ModifiedTimestamp": 1534452029.849,
          "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
          "Source": {
              "ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65/1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc29.docx&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180816T204149Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180816%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE"
          }
      },
      {
          "Id": "1529005196082-bb75fa19abc287699cb07147f75816dce43a53a10f28dc001bf61ef2fab01c59",
          "Name": "exampleDoc.pdf",
          "ContentType": "application/pdf",
          "Size": 425916,
          "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
          "Status": "ACTIVE",
          "CreatedTimestamp": 1529005196.082,
          "ModifiedTimestamp": 1529005196.796,
          "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
          "Source": {
              "ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65/1529005196082-bb75fa19abc287699cb07147f75816dce43a53a10f28dc001bf61ef2fab01c59?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc29.pdf&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180816T204149Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180816%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE"
          }
      }
  ]
}

Pour plus de détails sur l’API, consultez DescribeDocumentVersions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-folder-contents.

AWS CLI

Pour supprimer le contenu d’un dossier

Cet exemple décrit l’ensemble du contenu actif du dossier spécifié, y compris ses documents et sous-dossiers, triés par date dans l’ordre croissant.

Commande :


aws workdocs describe-folder-contents --folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 --sort DATE --order ASCENDING --type ALL

Sortie :


{
  "Folders": [
      {
          "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
          "Name": "testing",
          "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
          "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
          "CreatedTimestamp": 1534450467.622,
          "ModifiedTimestamp": 1534451113.504,
          "ResourceState": "ACTIVE",
          "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
          "Size": 23019,
          "LatestVersionSize": 11537
      }
  ],
  "Documents": [
      {
          "Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
          "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
          "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
          "CreatedTimestamp": 1529005196.082,
          "ModifiedTimestamp": 1534452483.01,
          "LatestVersionMetadata": {
              "Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef",
              "Name": "exampleDoc.docx",
              "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
              "Size": 13922,
              "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
              "Status": "ACTIVE",
              "CreatedTimestamp": 1534452029.587,
              "ModifiedTimestamp": 1534452029.587,
              "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
          },
          "ResourceState": "ACTIVE"
      }
  ]
}

Pour plus de détails sur l’API, consultez DescribeFolderContents dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-groups.

AWS CLI

Pour récupérer une liste de groupes

L’exemple describe-groups suivant répertorie les groupes associés à l’organisation Amazon WorkDocs spécifiée.


aws workdocs describe-groups \
    --search-query "e" \
    --organization-id d-123456789c

Sortie :


{
    "Groups": [
        {
            "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444&d-123456789c",
            "Name": "Example Group 1"
        },
        {
            "Id": "S-1-1-11-1122222222-2222233333-3333334444-5555&d-123456789c",
            "Name": "Example Group 2"
        }
    ]
}

Pour plus d’informations, consultez Mise en route avec Amazon WorkDocs dans le Guide de l’administrateur Amazon WorkDocs.

Pour plus de détails sur l’API, consultez DescribeGroups dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-notification-subscriptions.

AWS CLI

Pour récupérer une liste des abonnements aux notifications

L’exemple describe-notification-subscriptions suivant récupère les abonnements aux notifications pour l’organisation Amazon WorkDocs spécifiée.


aws workdocs describe-notification-subscriptions \
    --organization-id d-123456789c

Sortie :


{
    "Subscriptions": [
        {
            "SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123",
            "EndPoint": "https://example.com/example",
            "Protocol": "HTTPS"
        }
    ]
}

Pour plus d’informations, consultez S’abonner aux notifications dans le Manuel du développeur Amazon WorkDocs.

Pour plus de détails sur l’API, consultez DescribeNotificationSubscriptions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-resource-permissions.

AWS CLI

Pour obtenir une liste des autorisations pour une ressource

Cet exemple renvoie une liste des autorisations pour la ressource spécifiée (document ou dossier).

Commande :


aws workdocs describe-resource-permissions --resource-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3

Sortie :


{
  "Principals": [
      {
          "Id": "anonymous",
          "Type": "ANONYMOUS",
          "Roles": [
              {
                  "Role": "VIEWER",
                  "Type": "DIRECT"
              }
          ]
      },
      {
          "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
          "Type": "USER",
          "Roles": [
              {
                  "Role": "OWNER",
                  "Type": "DIRECT"
              }
          ]
      },
      {
          "Id": "d-926726012c",
          "Type": "ORGANIZATION",
          "Roles": [
              {
                  "Role": "VIEWER",
                  "Type": "INHERITED"
              }
          ]
      }
  ]
}

Pour plus de détails sur l’API, consultez DescribeResourcePermissions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser describe-users.

AWS CLI

Pour récupérer les informations relatives aux utilisateurs spécifiés

Cet exemple extrait les informations de tous les utilisateurs de l’organisation spécifiée.

Commande :


aws workdocs describe-users --organization-id d-926726012c

Sortie :


{
  "Users": [
      {
          "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
          "Username": "example1User",
          "OrganizationId": "d-926726012c",
          "RootFolderId": "3c0e3f849dd20a9771d937b9bbcc97e18796150ae56c26d64a4fa0320a2dedc9",
          "RecycleBinFolderId": "c277f4c4d647be1f5147b3184ffa96e1e2bf708278b696cacba68ba13b91f4fe",
          "Status": "INACTIVE",
          "Type": "USER",
          "CreatedTimestamp": 1535478999.452,
          "ModifiedTimestamp": 1535478999.452
      },
      {
          "Id": "S-1-1-11-1111111111-2222222222-3333333333-4444&d-926726012c",
          "Username": "example2User",
          "EmailAddress": "example2User@site.awsapps.com",
          "GivenName": "example2Name",
          "Surname": "example2Surname",
          "OrganizationId": "d-926726012c",
          "RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390",
          "RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff",
          "Status": "ACTIVE",
          "Type": "MINIMALUSER",
          "CreatedTimestamp": 1535478836.584,
          "ModifiedTimestamp": 1535478836.584
      }
  ]
}

Pour plus de détails sur l’API, consultez DescribeUsers dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-document-path.

AWS CLI

Pour récupérer les informations relatives au chemin d’un document

Cet exemple extrait les informations de chemin (la hiérarchie du dossier racine) du document spécifié et inclut les noms des dossiers parents.

Commande :


aws workdocs get-document-path --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --fields NAME

Sortie :


{
  "Path": {
      "Components": [
          {
              "Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3",
              "Name": "/"
          },
          {
              "Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
              "Name": "Top Level Folder"
          },
          {
              "Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
              "Name": "exampleDoc.docx"
          }
      ]
  }
}

Pour plus de détails sur l’API, consultez GetDocumentPath dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-document-version.

AWS CLI

Pour récupérer les métadonnées de version d’un document spécifié

Cet exemple extrait les métadonnées de version du document spécifié, y compris une URL source et des métadonnées personnalisées.

Commande :


aws workdocs get-document-version --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --fields SOURCE --include-custom-metadata

Sortie :


{
  "Metadata": {
      "Id": "1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920",
      "Name": "exampleDoc",
      "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
      "Size": 11537,
      "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
      "Status": "ACTIVE",
      "CreatedTimestamp": 1521672507.741,
      "ModifiedTimestamp": 1534451113.504,
      "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "Source": {
          "ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3/1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180820T212202Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180820%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE"
      }
  }
}

Pour plus de détails sur l’API, consultez GetDocumentVersion dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-document.

AWS CLI

Pour récupérer les détails d’un document

Cet exemple extrait les détails du document spécifié.

Commande :


aws workdocs get-document --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65

Sortie :


{
  "Metadata": {
      "Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65",
      "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
      "CreatedTimestamp": 1529005196.082,
      "ModifiedTimestamp": 1534452483.01,
      "LatestVersionMetadata": {
          "Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef",
          "Name": "exampleDoc.docx",
          "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
          "Size": 13922,
          "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
          "Status": "ACTIVE",
          "CreatedTimestamp": 1534452029.587,
          "ModifiedTimestamp": 1534452029.587,
          "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c"
      },
      "ResourceState": "ACTIVE"
  }
}

Pour plus de détails sur l’API, consultez GetDocument dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-folder-path.

AWS CLI

Pour récupérer les informations de chemin d’un dossier

Cet exemple extrait les informations de chemin (la hiérarchie du dossier racine) du dossier spécifié et inclut les noms des dossiers parents.

Commande :


aws workdocs get-folder-path --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08 --fields NAME

Sortie :


{
  "Path": {
      "Components": [
          {
              "Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3",
              "Name": "/"
          },
          {
              "Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
              "Name": "Top Level Folder"
          },
          {
              "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
              "Name": "Sublevel Folder"
          }
      ]
  }
}

Pour plus de détails sur l’API, consultez GetFolderPath dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-folder.

AWS CLI

Pour récupérer les métadonnées d’un dossier

Cet exemple extrait les métadonnées du dossier spécifié.

Commande :


aws workdocs get-folder --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08

Sortie :


{
  "Metadata": {
      "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08",
      "Name": "exampleFolder",
      "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678",
      "CreatedTimestamp": 1534450467.622,
      "ModifiedTimestamp": 1534451113.504,
      "ResourceState": "ACTIVE",
      "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE",
      "Size": 23019,
      "LatestVersionSize": 11537
  }
}

Pour plus de détails sur l’API, consultez GetFolder dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser get-resources.

AWS CLI

Pour récupérer des ressources partagées

L’exemple get-resources suivant récupère les ressources partagées avec l’utilisateur Amazon WorkDocs spécifié.


aws workdocs get-resources \
    --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333" \
    --collection-type SHARED_WITH_ME

Sortie :


{
"Folders": [],
"Documents": []
}

Pour plus d’informations, consultez Partage de fichiers et de dossiers dans le Guide de l’utilisateur Amazon WorkDocs.

Pour plus de détails sur l’API, consultez GetResources dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser initiate-document-version-upload.

AWS CLI

Pour démarrer le chargement de la version d’un document

L’exemple initiate-document-upload suivant crée un nouvel objet de document et un nouvel objet de version.


aws workdocs initiate-document-version-upload \
    --name exampledocname \
    --parent-folder-id eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189

Sortie :


{
    "Metadata": {
        "Id": "feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2",
        "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
        "ParentFolderId": "eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189",
        "CreatedTimestamp": 1536773972.914,
        "ModifiedTimestamp": 1536773972.914,
        "LatestVersionMetadata": {
            "Id": "1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313",
            "Name": "exampledocname",
            "ContentType": "application/octet-stream",
            "Size": 0,
            "Status": "INITIALIZED",
            "CreatedTimestamp": 1536773972.914,
            "ModifiedTimestamp": 1536773972.914,
            "CreatorId": "arn:aws:iam::123456789123:user/EXAMPLE"
        },
        "ResourceState": "ACTIVE"
    },
    "UploadMetadata": {
        "UploadUrl": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2/1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313?X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180912T173932Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180912%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE",
        "SignedHeaders": {
            "Content-Type": "application/octet-stream",
            "x-amz-server-side-encryption": "ABC123"
        }
    }
}

Pour plus de détails sur l’API, consultez InitiateDocumentVersionUpload dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser remove-all-resource-permissions.

AWS CLI

Pour supprimer toutes les autorisations d’une ressource spécifiée

Cet exemple supprime toutes les autorisations de la ressource spécifiée.

Commande :


aws workdocs remove-all-resource-permissions --resource-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678

Sortie :


None

Pour plus de détails sur l’API, consultez RemoveAllResourcePermissions dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser remove-resource-permission.

AWS CLI

Pour supprimer les autorisations d’une ressource

Cet exemple supprime les autorisations de la ressource pour le principal spécifié.

Commande :


aws workdocs remove-resource-permission --resource-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 --principal-id anonymous

Sortie :


None

Pour plus de détails sur l’API, consultez RemoveResourcePermission dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-document-version.

AWS CLI

Pour définir le statut de version d’un document sur Actif

Cet exemple définit l’état de la version du document sur Actif.

Commande :


aws workdocs update-document-version --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --version-status ACTIVE

Sortie :


None

Pour plus de détails sur l’API, consultez UpdateDocumentVersion dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-document.

AWS CLI

Pour mettre à jour un document

Cet exemple met à jour le nom et le dossier parent d’un document.

Commande :


aws workdocs update-document --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --name updatedDoc --parent-folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08

Sortie :


None

Pour plus de détails sur l’API, consultez UpdateDocument dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-folder.

AWS CLI

Pour mettre à jour un dossier

Cet exemple met à jour le nom et le dossier parent d’un dossier.

Commande :


aws workdocs update-folder --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08 --name exampleFolder1 --parent-folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678

Sortie :


None

Pour plus de détails sur l’API, consultez UpdateFolder dans la Référence des commandes de l’AWS CLI.

L’exemple de code suivant montre comment utiliser update-user.

AWS CLI

Pour mettre à jour un utilisateur

Cet exemple met à jour le fuseau horaire de l’utilisateur spécifié.

Commande :


aws workdocs update-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c" --time-zone-id "America/Los_Angeles"

Sortie :


{
  "User": {
      "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c",
      "Username": "exampleUser",
      "EmailAddress": "exampleUser@site.awsapps.com",
      "GivenName": "Example",
      "Surname": "User",
      "OrganizationId": "d-926726012c",
      "RootFolderId": "c5eceb5e1a2d1d460c9d1af8330ae117fc8d39bb1d3ed6acd0992d5ff192d986",
      "RecycleBinFolderId": "6ca20102926ad15f04b1d248d6d6e44f2449944eda5c758f9a1e9df6a6b7fa66",
      "Status": "ACTIVE",
      "Type": "USER",
      "TimeZoneId": "America/Los_Angeles",
      "Storage": {
          "StorageUtilizedInBytes": 0,
          "StorageRule": {
              "StorageAllocatedInBytes": 53687091200,
              "StorageType": "QUOTA"
          }
      }
  }
}

Pour plus de détails sur l’API, consultez UpdateUser dans la Référence des commandes de l’AWS CLI.

Avertissement JavaScript est désactivé ou n'est pas disponible dans votre navigateur.

Pour que vous puissiez utiliser la documentation AWS, Javascript doit être activé. Vous trouverez des instructions sur les pages d'aide de votre navigateur.

Conventions de rédaction

AWS WAFV2

Amazon WorkMail