を使用した Amazon WorkDocs の例 AWS CLI - AWS SDK コード例

Doc AWS SDK Examples リポジトリには、他にも SDK の例があります。 AWS GitHub

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

を使用した Amazon WorkDocs の例 AWS CLI

次のコード例は、Amazon AWS Command Line Interface で を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています WorkDocs。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、関連するシナリオやサービス間の例ではアクションのコンテキストが確認できます。

「シナリオ」は、同じサービス内で複数の関数を呼び出して、特定のタスクを実行する方法を示すコード例です。

各例には、 へのリンクが含まれています。このリンクには GitHub、コンテキスト内でコードをセットアップして実行する方法の手順が記載されています。

トピック

アクション

次の例は、abort-document-version-upload を使用する方法を説明しています。

AWS CLI

ドキュメントバージョンのアップロードを停止するには

この例では、以前に開始したドキュメントバージョンのアップロードを停止します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスAbortDocumentVersionUpload」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスActivateUser」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスAddResourcePermissions」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスCreateComment」の「」を参照してください。 AWS CLI

次の例は、create-custom-metadata を使用する方法を説明しています。

AWS CLI

カスタムメタデータを作成するには

この例では、指定したドキュメントのカスタムメタデータを作成します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスCreateCustomMetadata」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスCreateFolder」の「」を参照してください。 AWS CLI

次の例は、create-labels を使用する方法を説明しています。

AWS CLI

ラベルを作成するには

この例では、ドキュメントの一連のラベルを作成します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスCreateLabels」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「通知にサブスクライブする」を参照してください。

次の例は、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 の詳細については、「 コマンドリファレンスCreateUser」の「」を参照してください。 AWS CLI

次の例は、deactivate-user を使用する方法を説明しています。

AWS CLI

ユーザーを非アクティブ化するには

この例では、アクティブなユーザーを非アクティブ化します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスDeactivateUser」の「」を参照してください。 AWS CLI

次の例は、delete-comment を使用する方法を説明しています。

AWS CLI

ドキュメントバージョンから指定したコメントを削除するには

この例では、指定したドキュメントバージョンから指定したコメントを削除します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスDeleteComment」の「」を参照してください。 AWS CLI

次の例は、delete-custom-metadata を使用する方法を説明しています。

AWS CLI

リソースからカスタムメタデータを削除するには

この例では、指定したリソースからすべてのカスタムメタデータを削除します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスDeleteCustomMetadata」の「」を参照してください。 AWS CLI

次の例は、delete-document を使用する方法を説明しています。

AWS CLI

ドキュメントを削除するには

この例では、指定されたドキュメントを削除します。

コマンド:

aws workdocs delete-document --document-id b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a

出力:

None
  • API の詳細については、「 コマンドリファレンスDeleteDocument」の「」を参照してください。 AWS CLI

次の例は、delete-folder-contents を使用する方法を説明しています。

AWS CLI

フォルダの内容を削除するには

この例では、指定されたフォルダの内容を削除します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスDeleteFolderContents」の「」を参照してください。 AWS CLI

次の例は、delete-folder を使用する方法を説明しています。

AWS CLI

フォルダを削除するには

この例では、指定されたフォルダを削除します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスDeleteFolder」の「」を参照してください。 AWS CLI

次の例は、delete-labels を使用する方法を説明しています。

AWS CLI

ラベルを削除するには

この例では、指定されたラベルをドキュメントから削除します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスDeleteLabels」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「通知にサブスクライブする」を参照してください。

次の例は、delete-user を使用する方法を説明しています。

AWS CLI

ユーザーを削除するには

この例では、ユーザーを削除します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスDeleteUser」の「」を参照してください。 AWS CLI

次の例は、describe-activities を使用する方法を説明しています。

AWS CLI

ユーザーアクティビティのリストを取得するには

この例では、指定した組織の最新のユーザーアクティビティのリストと、最新の 2 つのアクティビティに対する制限が設定されています。

コマンド:

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 の詳細については、「 コマンドリファレンスDescribeActivities」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスDescribeComments」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスDescribeDocumentVersions」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスDescribeFolderContents」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスDescribeGroups」の「」を参照してください。 AWS CLI

次の例は、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 デベロッパーガイド」の「通知にサブスクライブする」を参照してください。

次の例は、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 の詳細については、「 コマンドリファレンスDescribeResourcePermissions」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスDescribeUsers」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスGetDocumentPath」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスGetDocumentVersion」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスGetDocument」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスGetFolderPath」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスGetFolder」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスGetResources」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスInitiateDocumentVersionUpload」の「」を参照してください。 AWS CLI

次の例は、remove-all-resource-permissions を使用する方法を説明しています。

AWS CLI

指定されたリソースからすべてのアクセス許可を削除するには

この例では、指定されたリソースからすべてのアクセス許可を削除します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスRemoveAllResourcePermissions」の「」を参照してください。 AWS CLI

次の例は、remove-resource-permission を使用する方法を説明しています。

AWS CLI

リソースからアクセス許可を削除するには

この例では、指定されたプリンシパルのリソースからアクセス許可を削除します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスRemoveResourcePermission」の「」を参照してください。 AWS CLI

次の例は、update-document-version を使用する方法を説明しています。

AWS CLI

ドキュメントバージョンのステータスを Active に変更するには

この例では、ドキュメントバージョンのステータスをアクティブに変更します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスUpdateDocumentVersion」の「」を参照してください。 AWS CLI

次の例は、update-document を使用する方法を説明しています。

AWS CLI

ドキュメントを更新するには

この例では、ドキュメントの名前と親フォルダを更新します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスUpdateDocument」の「」を参照してください。 AWS CLI

次の例は、update-folder を使用する方法を説明しています。

AWS CLI

フォルダを更新するには

この例では、フォルダの名前と親フォルダを更新します。

コマンド:

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

出力:

None
  • API の詳細については、「 コマンドリファレンスUpdateFolder」の「」を参照してください。 AWS CLI

次の例は、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 の詳細については、「 コマンドリファレンスUpdateUser」の「」を参照してください。 AWS CLI