WorkDocs Beispiele mit AWS CLI - AWS Command Line Interface
Aktionen

Diese Dokumentation bezieht sich AWS CLI nur auf Version 1 von. Dokumentation zu Version 2 von finden Sie im Benutzerhandbuch für Version 2. AWS CLI

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

WorkDocs Beispiele mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von AWS Command Line Interface with Aktionen ausführen und allgemeine Szenarien implementieren WorkDocs.

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Während Aktionen Ihnen zeigen, wie Sie einzelne Service-Funktionen aufrufen, können Sie Aktionen im Kontext der zugehörigen Szenarien anzeigen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, wo Sie Anleitungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt, wie Sieabort-document-version-upload.

AWS CLI

So stoppen Sie den Upload einer Dokumentversion

In diesem Beispiel wird ein bereits initiierter Upload einer Dokumentversion gestoppt.

Befehl:

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

Ausgabe:

None

Das folgende Codebeispiel zeigt die Verwendungactivate-user.

AWS CLI

So aktivieren Sie einen Benutzer

In diesem Beispiel wird ein inaktiver Benutzer aktiviert.

Befehl:

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

Ausgabe:

{
  "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"
          }
      }
  }
}

  • Einzelheiten zur API finden Sie ActivateUserin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungadd-resource-permissions.

AWS CLI

So fügen Sie einer Ressource Berechtigungen hinzu

In diesem Beispiel werden der Ressource Berechtigungen für die angegebenen Prinzipale hinzugefügt.

Befehl:

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

Ausgabe:

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

Das folgende Codebeispiel zeigt die Verwendungcreate-comment.

AWS CLI

So fügen Sie einen neuen Kommentar hinzu

In diesem Beispiel wird der angegebenen Dokumentversion ein neuer Kommentar hinzugefügt.

Befehl:

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

Ausgabe:

{
  "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"
  }
}

  • Einzelheiten zur API finden Sie CreateCommentin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungcreate-custom-metadata.

AWS CLI

So erstellen Sie benutzerdefinierte Metadaten

In diesem Beispiel werden benutzerdefinierte Metadaten für das angegebene Dokument erstellt.

Befehl:

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

Ausgabe:

None

Das folgende Codebeispiel zeigt die Verwendungcreate-folder.

AWS CLI

So erstellen Sie einen Ordner

In diesem Beispiel wird ein Ordner erstellt.

Befehl:

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

Ausgabe:

{
  "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
  }
}

  • Einzelheiten zur API finden Sie CreateFolderin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungcreate-labels.

AWS CLI

So erstellen Sie Labels

In diesem Beispiel werden eine Reihe von Labels für ein Dokument erstellt.

Befehl:

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

Ausgabe:

None

  • Einzelheiten zur API finden Sie CreateLabelsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungcreate-notification-subscription.

AWS CLI

So erstellen Sie ein Benachrichtigungsabonnement

Im folgenden create-notification-subscription Beispiel wird ein Benachrichtigungsabonnement für die angegebene WorkDocs Amazon-Organisation konfiguriert.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Benachrichtigungen abonnieren im Amazon WorkDocs Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungcreate-user.

AWS CLI

So erstellen Sie einen neuen Benutzer

In diesem Beispiel wird ein neuer Benutzer in einem Simple AD- oder Microsoft AD-Verzeichnis erstellt.

Befehl:

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

Ausgabe:

{
  "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"
          }
      }
  }
}

  • Einzelheiten zur API finden Sie CreateUserin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdeactivate-user.

AWS CLI

So deaktivieren Sie einen Benutzer

In diesem Beispiel wird ein aktiver Benutzer deaktiviert.

Befehl:

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

Ausgabe:

None

  • Einzelheiten zur API finden Sie DeactivateUserin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-comment.

AWS CLI

So löschen Sie einen angegebenen Kommentar aus einer Dokumentversion

In diesem Beispiel wird der angegebene Kommentar aus der angegebenen Dokumentversion gelöscht.

Befehl:

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

Ausgabe:

None

  • Einzelheiten zur API finden Sie DeleteCommentin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-custom-metadata.

AWS CLI

So löschen Sie benutzerdefinierte Metadaten aus einer Ressource

In diesem Beispiel werden alle benutzerdefinierten Metadaten aus der angegebenen Ressource gelöscht.

Befehl:

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

Ausgabe:

None

Das folgende Codebeispiel zeigt die Verwendungdelete-document.

AWS CLI

Löschen eines Dokuments

In diesem Beispiel wird das angegebene Dokument gelöscht.

Befehl:

aws workdocs delete-document --document-id b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a

Ausgabe:

None

  • Einzelheiten zur API finden Sie DeleteDocumentin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-folder-contents.

AWS CLI

So löschen Sie den Inhalt eines Ordners

In diesem Beispiel wird der Inhalt des angegebenen Ordners gelöscht.

Befehl:

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

Ausgabe:

None

Das folgende Codebeispiel zeigt die Verwendungdelete-folder.

AWS CLI

Um einen Ordner zu löschen

In diesem Beispiel wird der angegebene Ordner gelöscht.

Befehl:

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

Ausgabe:

None

  • Einzelheiten zur API finden Sie DeleteFolderin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-labels.

AWS CLI

So löschen Sie Labels

In diesem Beispiel werden die angegebenen Labels aus einem Dokument gelöscht.

Befehl:

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

Ausgabe:

None

  • Einzelheiten zur API finden Sie DeleteLabelsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-notification-subscription.

AWS CLI

So löschen Sie ein Benachrichtigungsabonnement

Im folgenden Beispiel für delete-notification-subscription wird das angegebene Benachrichtigungsabonnement gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Benachrichtigungen abonnieren im Amazon WorkDocs Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdelete-user.

AWS CLI

So löschen Sie einen Benutzer

In diesem Beispiel wird ein Benutzer gelöscht.

Befehl:

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

Ausgabe:

None

  • Einzelheiten zur API finden Sie DeleteUserin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdescribe-activities.

AWS CLI

So rufen Sie eine Liste der Benutzeraktivitäten ab

In diesem Beispiel wird eine Liste der letzten Benutzeraktivitäten für die angegebene Organisation zurückgegeben, wobei ein Limit für die letzten beiden Aktivitäten festgelegt wurde.

Befehl:

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

Ausgabe:

{
  "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"
}

Das folgende Codebeispiel zeigt die Verwendungdescribe-comments.

AWS CLI

So listen Sie alle Kommentare für die angegebene Dokumentversion auf

In diesem Beispiel werden alle Kommentare für die angegebene Dokumentversion aufgeführt.

Befehl:

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

Ausgabe:

{
  "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"
      }
  ]
}

  • Einzelheiten zur API finden Sie DescribeCommentsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdescribe-document-versions.

AWS CLI

So rufen Sie die Versionen eines Dokuments ab

In diesem Beispiel werden die Dokumentversionen des angegebene Dokuments abgerufen, einschließlich der initialisierten Versionen und einer URL für das Quelldokument.

Befehl:

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

Ausgabe:

{
  "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"
          }
      }
  ]
}

Das folgende Codebeispiel zeigt die Verwendungdescribe-folder-contents.

AWS CLI

So beschreiben Sie den Inhalt eines Ordners

In diesem Beispiel wird der gesamte aktive Inhalt des angegebenen Ordners, einschließlich seiner Dokumente und Unterordner, in aufsteigender Reihenfolge nach Datum sortiert.

Befehl:

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

Ausgabe:

{
  "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"
      }
  ]
}

Das folgende Codebeispiel zeigt die Verwendungdescribe-groups.

AWS CLI

So rufen Sie eine Liste mit Gruppen ab

Das folgende describe-groups Beispiel listet die Gruppen auf, die der angegebenen WorkDocs Amazon-Organisation zugeordnet sind.

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

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Erste Schritte mit Amazon WorkDocs im WorkDocs Amazon-Administratorhandbuch.

  • Einzelheiten zur API finden Sie DescribeGroupsin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdescribe-notification-subscriptions.

AWS CLI

So rufen Sie eine Liste mit Benachrichtigungsabonnements ab

Im folgenden describe-notification-subscriptions Beispiel werden die Benachrichtigungsabonnements für die angegebene WorkDocs Amazon-Organisation abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Benachrichtigungen abonnieren im Amazon WorkDocs Developer Guide.

Das folgende Codebeispiel zeigt die Verwendungdescribe-resource-permissions.

AWS CLI

So rufen Sie eine Liste der Berechtigungen einer Ressource ab

In diesem Beispiel wird eine Liste der Berechtigungen für die angegebene Ressource (Dokument oder Ordner) zurückgegeben.

Befehl:

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

Ausgabe:

{
  "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"
              }
          ]
      }
  ]
}

Das folgende Codebeispiel zeigt die Verwendungdescribe-users.

AWS CLI

So rufen Sie Details für bestimmte Benutzer ab

In diesem Beispiel werden Details für alle Benutzer in der angegebenen Organisation abgerufen.

Befehl:

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

Ausgabe:

{
  "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
      }
  ]
}

  • Einzelheiten zur API finden Sie DescribeUsersin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-document-path.

AWS CLI

So rufen Sie die Pfadinformationen eines Dokuments ab

In diesem Beispiel werden die Pfadinformationen (die Hierarchie aus dem Stammordner) für das angegebene Dokument abgerufen, einschließlich der Namen der übergeordneten Ordner.

Befehl:

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

Ausgabe:

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

  • Einzelheiten zur API finden Sie GetDocumentPathin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-document-version.

AWS CLI

So rufen Sie die Versionsmetadaten für ein angegebenes Dokument ab

In diesem Beispiel werden Versionsmetadaten für das angegebene Dokument abgerufen, einschließlich einer Quell-URL und benutzerdefinierter Metadaten.

Befehl:

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

Ausgabe:

{
  "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"
      }
  }
}

Das folgende Codebeispiel zeigt die Verwendungget-document.

AWS CLI

So rufen Sie Dokumentdetails ab

In diesem Beispiel werden die Details des angegebenen Dokuments abgerufen.

Befehl:

aws workdocs get-document --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65

Ausgabe:

{
  "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"
  }
}

  • Einzelheiten zur API finden Sie GetDocumentin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-folder-path.

AWS CLI

So rufen Sie Pfadinformationen für einen Ordner ab

In diesem Beispiel werden die Pfadinformationen (die Hierarchie aus dem Stammordner) für den angegebenen Ordner, einschließlich der Namen der übergeordneten Ordner abgerufen.

Befehl:

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

Ausgabe:

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

  • Einzelheiten zur API finden Sie GetFolderPathin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-folder.

AWS CLI

So rufen Sie die Metadaten für einen Ordner ab

Im folgenden Beispiel werden die Metadaten für den angegebenen Ordner abgerufen.

Befehl:

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

Ausgabe:

{
  "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
  }
}

  • Einzelheiten zur API finden Sie GetFolderin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-resources.

AWS CLI

So rufen Sie freigegebene Ressourcen ab

Im folgenden get-resources Beispiel werden die Ressourcen abgerufen, die mit dem angegebenen WorkDocs Amazon-Benutzer geteilt wurden.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Dateien und Ordner teilen im WorkDocs Amazon-Benutzerhandbuch.

  • Einzelheiten zur API finden Sie GetResourcesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunginitiate-document-version-upload.

AWS CLI

So initiieren Sie den Upload einer Dokumentversion

Im folgenden Beispiel für initiate-document-upload wird ein neues Dokumentobjekt und Versionsobjekt erstellt.

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

Ausgabe:

{
    "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"
        }
    }
}

Das folgende Codebeispiel zeigt die Verwendungremove-all-resource-permissions.

AWS CLI

So entfernen Sie alle Berechtigungen aus einer angegebenen Ressource

In diesem Beispiel werden alle Berechtigungen aus der angegebenen Ressource entfernt.

Befehl:

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

Ausgabe:

None

Das folgende Codebeispiel zeigt die Verwendungremove-resource-permission.

AWS CLI

So entfernen Sie Berechtigungen aus einer Ressource

In diesem Beispiel werden die Berechtigungen für den angegebenen Prinzipal von der angegebenen Ressource entfernt.

Befehl:

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

Ausgabe:

None

Das folgende Codebeispiel zeigt die Verwendungupdate-document-version.

AWS CLI

So ändern Sie den Versionsstatus eines Dokuments auf Aktiv

In diesem Beispiel wird der Status der Dokumentversion auf AKTIV gesetzt.

Befehl:

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

Ausgabe:

None

Das folgende Codebeispiel zeigt die Verwendungupdate-document.

AWS CLI

So aktualisieren Sie ein Dokument

In diesem Beispiel werden der Name und der übergeordnete Ordner eines Dokuments aktualisiert.

Befehl:

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

Ausgabe:

None

  • Einzelheiten zur API finden Sie UpdateDocumentin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-folder.

AWS CLI

So erstellen Sie einen Ordner

In diesem Beispiel werden der Name und der übergeordnete Ordner eines Ordners aktualisiert.

Befehl:

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

Ausgabe:

None

  • Einzelheiten zur API finden Sie UpdateFolderin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-user.

AWS CLI

Um einen Benutzer zu aktualisieren

In diesem Beispiel wird die Zeitzone des angegebenen Benutzers aktualisiert.

Befehl:

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

Ausgabe:

{
  "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"
          }
      }
  }
}

  • Einzelheiten zur API finden Sie UpdateUserin der AWS CLI Befehlsreferenz.