使用的 Amazon WorkDocs 範例 AWS CLI

PDF

RSS

焦點模式

使用的 Amazon WorkDocs 範例 AWS CLI - AWS Command Line Interface

動作

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 Amazon WorkDocs 來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數，但您可以在其相關情境中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

動作

下列程式碼範例示範如何使用 abort-document-version-upload。

AWS CLI

停止文件版本上傳

此範例會停止先前啟動的文件版本上傳。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 AbortDocumentVersionUpload。

abort-document-version-upload

下列程式碼範例示範如何使用 abort-document-version-upload。

AWS CLI

停止文件版本上傳

此範例會停止先前啟動的文件版本上傳。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 AbortDocumentVersionUpload。

下列程式碼範例示範如何使用 activate-user。

AWS CLI

啟用使用者

此範例會啟用非作用中的使用者。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 ActivateUser。

activate-user

下列程式碼範例示範如何使用 activate-user。

AWS CLI

啟用使用者

此範例會啟用非作用中的使用者。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 ActivateUser。

下列程式碼範例示範如何使用 add-resource-permissions。

AWS CLI

新增資源的許可

此範例會將許可新增至指定主體的資源。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 AddResourcePermissions。

add-resource-permissions

下列程式碼範例示範如何使用 add-resource-permissions。

AWS CLI

新增資源的許可

此範例會將許可新增至指定主體的資源。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 AddResourcePermissions。

下列程式碼範例示範如何使用 create-comment。

AWS CLI

新增註解

此範例會將新的註解新增至指定的文件版本。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateComment。

create-comment

下列程式碼範例示範如何使用 create-comment。

AWS CLI

新增註解

此範例會將新的註解新增至指定的文件版本。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateComment。

下列程式碼範例示範如何使用 create-custom-metadata。

AWS CLI

建立自訂中繼資料

此範例會建立指定文件的自訂中繼資料。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateCustomMetadata。

create-custom-metadata

下列程式碼範例示範如何使用 create-custom-metadata。

AWS CLI

建立自訂中繼資料

此範例會建立指定文件的自訂中繼資料。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateCustomMetadata。

下列程式碼範例示範如何使用 create-folder。

AWS CLI

建立資料夾

此範例會建立資料夾。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateFolder。

create-folder

下列程式碼範例示範如何使用 create-folder。

AWS CLI

建立資料夾

此範例會建立資料夾。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateFolder。

下列程式碼範例示範如何使用 create-labels。

AWS CLI

建立標籤

此範例會建立文件的一系列標籤。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateLabels。

create-labels

下列程式碼範例示範如何使用 create-labels。

AWS CLI

建立標籤

此範例會建立文件的一系列標籤。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateLabels。

下列程式碼範例示範如何使用 create-notification-subscription。

AWS CLI

建立通知訂閱

下列create-notification-subscription範例會設定指定 Amazon WorkDocs 組織的通知訂閱。


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

輸出：


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

如需詳細資訊，請參閱《Amazon WorkDocs 開發人員指南》中的訂閱通知。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateNotificationSubscription。

create-notification-subscription

下列程式碼範例示範如何使用 create-notification-subscription。

AWS CLI

建立通知訂閱

下列create-notification-subscription範例會設定指定 Amazon WorkDocs 組織的通知訂閱。


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

輸出：


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

如需詳細資訊，請參閱《Amazon WorkDocs 開發人員指南》中的訂閱通知。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 CreateNotificationSubscription。

下列程式碼範例示範如何使用 create-user。

AWS CLI

建立新使用者

此範例會在 Simple AD 或 Microsoft AD 目錄中建立新的使用者。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateUser。

create-user

下列程式碼範例示範如何使用 create-user。

AWS CLI

建立新使用者

此範例會在 Simple AD 或 Microsoft AD 目錄中建立新的使用者。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 CreateUser。

下列程式碼範例示範如何使用 deactivate-user。

AWS CLI

停用使用者

此範例會停用作用中的使用者。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeactivateUser。

deactivate-user

下列程式碼範例示範如何使用 deactivate-user。

AWS CLI

停用使用者

此範例會停用作用中的使用者。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeactivateUser。

下列程式碼範例示範如何使用 delete-comment。

AWS CLI

從文件版本中刪除指定的註解

此範例會從指定的文件版本中刪除指定的註解。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteComment。

delete-comment

下列程式碼範例示範如何使用 delete-comment。

AWS CLI

從文件版本中刪除指定的註解

此範例會從指定的文件版本中刪除指定的註解。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteComment。

下列程式碼範例示範如何使用 delete-custom-metadata。

AWS CLI

從資源刪除自訂中繼資料

此範例會從指定的資源刪除所有自訂中繼資料。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteCustomMetadata。

delete-custom-metadata

下列程式碼範例示範如何使用 delete-custom-metadata。

AWS CLI

從資源刪除自訂中繼資料

此範例會從指定的資源刪除所有自訂中繼資料。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteCustomMetadata。

下列程式碼範例示範如何使用 delete-document。

AWS CLI

刪除文件

此範例會刪除指定的文件。

命令：


aws workdocs delete-document --document-id b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a

輸出：


None

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteDocument。

delete-document

下列程式碼範例示範如何使用 delete-document。

AWS CLI

刪除文件

此範例會刪除指定的文件。

命令：


aws workdocs delete-document --document-id b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a

輸出：


None

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteDocument。

下列程式碼範例示範如何使用 delete-folder-contents。

AWS CLI

刪除資料夾的內容

此範例會刪除指定資料夾的內容。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteFolderContents。

delete-folder-contents

下列程式碼範例示範如何使用 delete-folder-contents。

AWS CLI

刪除資料夾的內容

此範例會刪除指定資料夾的內容。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteFolderContents。

下列程式碼範例示範如何使用 delete-folder。

AWS CLI

刪除資料夾

此範例會刪除指定的資料夾。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteFolder。

delete-folder

下列程式碼範例示範如何使用 delete-folder。

AWS CLI

刪除資料夾

此範例會刪除指定的資料夾。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteFolder。

下列程式碼範例示範如何使用 delete-labels。

AWS CLI

刪除標籤

此範例會從文件中刪除指定的標籤。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteLabels。

delete-labels

下列程式碼範例示範如何使用 delete-labels。

AWS CLI

刪除標籤

此範例會從文件中刪除指定的標籤。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteLabels。

下列程式碼範例示範如何使用 delete-notification-subscription。

AWS CLI

刪除通知訂閱

下列delete-notification-subscription範例會刪除指定的通知訂閱。


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

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon WorkDocs 開發人員指南》中的訂閱通知。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteNotificationSubscription。

delete-notification-subscription

下列程式碼範例示範如何使用 delete-notification-subscription。

AWS CLI

刪除通知訂閱

下列delete-notification-subscription範例會刪除指定的通知訂閱。


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

此命令不會產生輸出。

如需詳細資訊，請參閱《Amazon WorkDocs 開發人員指南》中的訂閱通知。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DeleteNotificationSubscription。

下列程式碼範例示範如何使用 delete-user。

AWS CLI

若要刪除使用者

此範例會刪除使用者。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteUser。

delete-user

下列程式碼範例示範如何使用 delete-user。

AWS CLI

若要刪除使用者

此範例會刪除使用者。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 DeleteUser。

下列程式碼範例示範如何使用 describe-activities。

AWS CLI

取得使用者活動清單

此範例會傳回指定組織的最新使用者活動清單，並針對最近兩個活動設定限制。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeActivities。

describe-activities

下列程式碼範例示範如何使用 describe-activities。

AWS CLI

取得使用者活動清單

此範例會傳回指定組織的最新使用者活動清單，並針對最近兩個活動設定限制。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeActivities。

下列程式碼範例示範如何使用 describe-comments。

AWS CLI

列出指定文件版本的所有註解

此範例會列出指定文件版本的所有註解。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeComments。

describe-comments

下列程式碼範例示範如何使用 describe-comments。

AWS CLI

列出指定文件版本的所有註解

此範例會列出指定文件版本的所有註解。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeComments。

下列程式碼範例示範如何使用 describe-document-versions。

AWS CLI

擷取文件的版本

此範例會擷取指定文件的文件版本，包括初始化版本和來源文件的 URL。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeDocumentVersions。

describe-document-versions

下列程式碼範例示範如何使用 describe-document-versions。

AWS CLI

擷取文件的版本

此範例會擷取指定文件的文件版本，包括初始化版本和來源文件的 URL。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeDocumentVersions。

下列程式碼範例示範如何使用 describe-folder-contents。

AWS CLI

描述資料夾的內容

此範例說明指定資料夾的所有作用中內容，包括其文件和子資料夾，依日期遞增排序。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeFolderContents。

describe-folder-contents

下列程式碼範例示範如何使用 describe-folder-contents。

AWS CLI

描述資料夾的內容

此範例說明指定資料夾的所有作用中內容，包括其文件和子資料夾，依日期遞增排序。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeFolderContents。

下列程式碼範例示範如何使用 describe-groups。

AWS CLI

擷取群組清單

下列describe-groups範例列出與指定 Amazon WorkDocs 組織相關聯的群組。


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

輸出：


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

如需詳細資訊，請參閱 Amazon WorkDocs 管理指南中的 Amazon WorkDocs 入門。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeGroups。

describe-groups

下列程式碼範例示範如何使用 describe-groups。

AWS CLI

擷取群組清單

下列describe-groups範例列出與指定 Amazon WorkDocs 組織相關聯的群組。


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

輸出：


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

如需詳細資訊，請參閱 Amazon WorkDocs 管理指南中的 Amazon WorkDocs 入門。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeGroups。

下列程式碼範例示範如何使用 describe-notification-subscriptions。

AWS CLI

擷取通知訂閱清單

下列describe-notification-subscriptions範例會擷取指定 Amazon WorkDocs 組織的通知訂閱。


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

輸出：


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

如需詳細資訊，請參閱《Amazon WorkDocs 開發人員指南》中的訂閱通知。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeNotificationSubscriptions。

describe-notification-subscriptions

下列程式碼範例示範如何使用 describe-notification-subscriptions。

AWS CLI

擷取通知訂閱清單

下列describe-notification-subscriptions範例會擷取指定 Amazon WorkDocs 組織的通知訂閱。


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

輸出：


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

如需詳細資訊，請參閱《Amazon WorkDocs 開發人員指南》中的訂閱通知。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeNotificationSubscriptions。

下列程式碼範例示範如何使用 describe-resource-permissions。

AWS CLI

取得資源的許可清單

此範例會傳回指定資源（文件或資料夾）的許可清單。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeResourcePermissions。

describe-resource-permissions

下列程式碼範例示範如何使用 describe-resource-permissions。

AWS CLI

取得資源的許可清單

此範例會傳回指定資源（文件或資料夾）的許可清單。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeResourcePermissions。

下列程式碼範例示範如何使用 describe-users。

AWS CLI

擷取指定使用者的詳細資訊

此範例會擷取指定組織中所有使用者的詳細資訊。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeUsers。

describe-users

下列程式碼範例示範如何使用 describe-users。

AWS CLI

擷取指定使用者的詳細資訊

此範例會擷取指定組織中所有使用者的詳細資訊。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 DescribeUsers。

下列程式碼範例示範如何使用 get-document-path。

AWS CLI

擷取文件的路徑資訊

此範例會擷取指定文件的路徑資訊（來自根資料夾的階層），並包含父資料夾的名稱。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDocumentPath。

get-document-path

下列程式碼範例示範如何使用 get-document-path。

AWS CLI

擷取文件的路徑資訊

此範例會擷取指定文件的路徑資訊（來自根資料夾的階層），並包含父資料夾的名稱。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDocumentPath。

下列程式碼範例示範如何使用 get-document-version。

AWS CLI

擷取指定文件的版本中繼資料

此範例會擷取指定文件的版本中繼資料，包括來源 URL 和自訂中繼資料。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDocumentVersion。

get-document-version

下列程式碼範例示範如何使用 get-document-version。

AWS CLI

擷取指定文件的版本中繼資料

此範例會擷取指定文件的版本中繼資料，包括來源 URL 和自訂中繼資料。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetDocumentVersion。

下列程式碼範例示範如何使用 get-document。

AWS CLI

擷取文件詳細資訊

此範例會擷取指定文件的詳細資訊。

命令：


aws workdocs get-document --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65

輸出：


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

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetDocument。

get-document

下列程式碼範例示範如何使用 get-document。

AWS CLI

擷取文件詳細資訊

此範例會擷取指定文件的詳細資訊。

命令：


aws workdocs get-document --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65

輸出：


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

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 GetDocument。

下列程式碼範例示範如何使用 get-folder-path。

AWS CLI

擷取資料夾的路徑資訊

此範例會擷取指定資料夾的路徑資訊（來自根資料夾的階層），並包含父資料夾的名稱。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetFolderPath。

get-folder-path

下列程式碼範例示範如何使用 get-folder-path。

AWS CLI

擷取資料夾的路徑資訊

此範例會擷取指定資料夾的路徑資訊（來自根資料夾的階層），並包含父資料夾的名稱。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetFolderPath。

下列程式碼範例示範如何使用 get-folder。

AWS CLI

擷取資料夾的中繼資料

此範例會擷取指定資料夾的中繼資料。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetFolder。

get-folder

下列程式碼範例示範如何使用 get-folder。

AWS CLI

擷取資料夾的中繼資料

此範例會擷取指定資料夾的中繼資料。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetFolder。

下列程式碼範例示範如何使用 get-resources。

AWS CLI

擷取共用資源

下列get-resources範例會擷取與指定 Amazon WorkDocs 使用者共用的資源。


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

輸出：


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

如需詳細資訊，請參閱《Amazon WorkDocs 使用者指南》中的共用檔案和資料夾。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetResources。

get-resources

下列程式碼範例示範如何使用 get-resources。

AWS CLI

擷取共用資源

下列get-resources範例會擷取與指定 Amazon WorkDocs 使用者共用的資源。


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

輸出：


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

如需詳細資訊，請參閱《Amazon WorkDocs 使用者指南》中的共用檔案和資料夾。

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 GetResources。

下列程式碼範例示範如何使用 initiate-document-version-upload。

AWS CLI

啟動文件版本上傳

下列initiate-document-upload範例會建立新的文件物件和版本物件。


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 InitiateDocumentVersionUpload。

initiate-document-version-upload

下列程式碼範例示範如何使用 initiate-document-version-upload。

AWS CLI

啟動文件版本上傳

下列initiate-document-upload範例會建立新的文件物件和版本物件。


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

輸出：


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

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 InitiateDocumentVersionUpload。

下列程式碼範例示範如何使用 remove-all-resource-permissions。

AWS CLI

從指定的資源移除所有許可

此範例會從指定的資源移除所有許可。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 RemoveAllResourcePermissions。

remove-all-resource-permissions

下列程式碼範例示範如何使用 remove-all-resource-permissions。

AWS CLI

從指定的資源移除所有許可

此範例會從指定的資源移除所有許可。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 RemoveAllResourcePermissions。

下列程式碼範例示範如何使用 remove-resource-permission。

AWS CLI

從資源移除許可

此範例會從指定主體的資源中移除許可。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 RemoveResourcePermission。

remove-resource-permission

下列程式碼範例示範如何使用 remove-resource-permission。

AWS CLI

從資源移除許可

此範例會從指定主體的資源中移除許可。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 RemoveResourcePermission。

下列程式碼範例示範如何使用 update-document-version。

AWS CLI

將文件版本狀態變更為作用中

此範例會將文件版本的狀態變更為作用中。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateDocumentVersion。

update-document-version

下列程式碼範例示範如何使用 update-document-version。

AWS CLI

將文件版本狀態變更為作用中

此範例會將文件版本的狀態變更為作用中。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateDocumentVersion。

下列程式碼範例示範如何使用 update-document。

AWS CLI

更新文件

此範例會更新文件的名稱和父資料夾。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 UpdateDocument。

update-document

下列程式碼範例示範如何使用 update-document。

AWS CLI

更新文件

此範例會更新文件的名稱和父資料夾。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 UpdateDocument。

下列程式碼範例示範如何使用 update-folder。

AWS CLI

更新資料夾

此範例會更新資料夾的名稱和父資料夾。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateFolder。

update-folder

下列程式碼範例示範如何使用 update-folder。

AWS CLI

更新資料夾

此範例會更新資料夾的名稱和父資料夾。

命令：


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

輸出：


None

如需 API 詳細資訊，請參閱 AWS CLI 命令參考中的 UpdateFolder。

下列程式碼範例示範如何使用 update-user。

AWS CLI

更新使用者

此範例會更新指定使用者的時區。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 UpdateUser。

update-user

下列程式碼範例示範如何使用 update-user。

AWS CLI

更新使用者

此範例會更新指定使用者的時區。

命令：


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

輸出：


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

如需 API 詳細資訊，請參閱《AWS CLI 命令參考》中的 UpdateUser。

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

AWS WAFV2

Amazon WorkMail

在本頁面

選取您的 Cookie 偏好設定

使用 的 Amazon WorkDocs 範例 AWS CLI

主題

動作

abort-document-version-upload

activate-user

add-resource-permissions

create-comment

create-custom-metadata

create-folder

create-labels

create-notification-subscription

create-user

deactivate-user

delete-comment

delete-custom-metadata

delete-document

delete-folder-contents

delete-folder

delete-labels

delete-notification-subscription

delete-user

describe-activities

describe-comments

describe-document-versions

describe-folder-contents

describe-groups

describe-notification-subscriptions

describe-resource-permissions

describe-users

get-document-path

get-document-version

get-document

get-folder-path

get-folder

get-resources

initiate-document-version-upload

remove-all-resource-permissions

remove-resource-permission

update-document-version

update-document

update-folder

update-user

在本頁面

此頁面是否有幫助？

下一個主題：

上一個主題：

需要協助？

使用的 Amazon WorkDocs 範例 AWS CLI