WorkDocs Contoh Amazon menggunakan AWS CLI

Contoh kode berikut menunjukkan cara melakukan tindakan dan mengimplementasikan skenario umum dengan menggunakan AWS Command Line Interface with Amazon WorkDocs.

Tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Topik

Tindakan

Tindakan

Contoh kode berikut menunjukkan cara menggunakanabort-document-version-upload.

AWS CLI

Untuk menghentikan unggahan versi dokumen

Contoh ini menghentikan unggahan versi dokumen yang dimulai sebelumnya.

Perintah:


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

Output:


None

Untuk API detailnya, lihat AbortDocumentVersionUploaddi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanactivate-user.

AWS CLI

Untuk mengaktifkan pengguna

Contoh ini mengaktifkan pengguna yang tidak aktif.

Perintah:


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

Output:


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

Untuk API detailnya, lihat ActivateUserdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanadd-resource-permissions.

AWS CLI

Untuk menambahkan izin untuk sumber daya

Contoh ini menambahkan izin ke sumber daya untuk prinsipal tertentu.

Perintah:


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

Output:


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

Untuk API detailnya, lihat AddResourcePermissionsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-comment.

AWS CLI

Untuk menambahkan komentar baru

Contoh ini menambahkan komentar baru ke versi dokumen yang ditentukan.

Perintah:


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

Output:


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

Untuk API detailnya, lihat CreateCommentdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-custom-metadata.

AWS CLI

Untuk membuat metadata kustom

Contoh ini membuat metadata kustom untuk dokumen yang ditentukan.

Perintah:


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

Output:


None

Untuk API detailnya, lihat CreateCustomMetadatadi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-folder.

AWS CLI

Untuk membuat folder

Contoh ini membuat folder.

Perintah:


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

Output:


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

Untuk API detailnya, lihat CreateFolderdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-labels.

AWS CLI

Untuk membuat label

Contoh ini membuat serangkaian label untuk dokumen.

Perintah:


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

Output:


None

Untuk API detailnya, lihat CreateLabelsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-notification-subscription.

AWS CLI

Untuk membuat langganan notifikasi

create-notification-subscriptionContoh berikut mengonfigurasi langganan notifikasi untuk WorkDocs organisasi Amazon yang ditentukan.


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

Output:


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

Untuk informasi selengkapnya, lihat Berlangganan Pemberitahuan di Panduan WorkDocs Pengembang Amazon.

Untuk API detailnya, lihat CreateNotificationSubscriptiondi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-user.

AWS CLI

Untuk membuat pengguna baru

Contoh ini membuat pengguna baru di direktori Simple AD atau Microsoft AD.

Perintah:


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

Output:


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

Untuk API detailnya, lihat CreateUserdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandeactivate-user.

AWS CLI

Untuk menonaktifkan pengguna

Contoh ini menonaktifkan pengguna aktif.

Perintah:


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

Output:


None

Untuk API detailnya, lihat DeactivateUserdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-comment.

AWS CLI

Untuk menghapus komentar tertentu dari versi dokumen

Contoh ini menghapus komentar yang ditentukan dari versi dokumen yang ditentukan.

Perintah:


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

Output:


None

Untuk API detailnya, lihat DeleteCommentdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-custom-metadata.

AWS CLI

Untuk menghapus metadata kustom dari sumber daya

Contoh ini menghapus semua metadata kustom dari sumber daya yang ditentukan.

Perintah:


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

Output:


None

Untuk API detailnya, lihat DeleteCustomMetadatadi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-document.

AWS CLI

Untuk menghapus dokumen

Contoh ini menghapus dokumen yang ditentukan.

Perintah:


aws workdocs delete-document --document-id b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a

Output:


None

Untuk API detailnya, lihat DeleteDocumentdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-folder-contents.

AWS CLI

Untuk menghapus isi folder

Contoh ini menghapus isi folder yang ditentukan.

Perintah:


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

Output:


None

Untuk API detailnya, lihat DeleteFolderContentsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-folder.

AWS CLI

Untuk menghapus folder

Contoh ini menghapus folder yang ditentukan.

Perintah:


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

Output:


None

Untuk API detailnya, lihat DeleteFolderdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-labels.

AWS CLI

Untuk menghapus label

Contoh ini menghapus label yang ditentukan dari dokumen.

Perintah:


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

Output:


None

Untuk API detailnya, lihat DeleteLabelsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-notification-subscription.

AWS CLI

Untuk menghapus langganan notifikasi

delete-notification-subscriptionContoh berikut menghapus langganan pemberitahuan yang ditentukan.


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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Berlangganan Pemberitahuan di Panduan WorkDocs Pengembang Amazon.

Untuk API detailnya, lihat DeleteNotificationSubscriptiondi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-user.

AWS CLI

Untuk menghapus pengguna

Contoh ini menghapus pengguna.

Perintah:


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

Output:


None

Untuk API detailnya, lihat DeleteUserdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-activities.

AWS CLI

Untuk mendapatkan daftar aktivitas pengguna

Contoh ini menampilkan daftar aktivitas pengguna terbaru untuk organisasi tertentu, dengan batas yang ditetapkan untuk dua aktivitas terbaru.

Perintah:


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

Output:


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

Untuk API detailnya, lihat DescribeActivitiesdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-comments.

AWS CLI

Untuk daftar semua komentar untuk versi dokumen tertentu

Contoh ini mencantumkan semua komentar untuk versi dokumen yang ditentukan.

Perintah:


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

Output:


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

Untuk API detailnya, lihat DescribeCommentsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-document-versions.

AWS CLI

Untuk mengambil versi dokumen

Contoh ini mengambil versi dokumen untuk dokumen yang ditentukan, termasuk versi yang diinisialisasi dan URL untuk dokumen sumber.

Perintah:


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

Output:


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

Untuk API detailnya, lihat DescribeDocumentVersionsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-folder-contents.

AWS CLI

Untuk mendeskripsikan isi folder

Contoh ini menjelaskan semua konten aktif dari folder yang ditentukan, termasuk dokumen dan subfoldernya, diurutkan berdasarkan tanggal dalam urutan menaik.

Perintah:


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

Output:


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

Untuk API detailnya, lihat DescribeFolderContentsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-groups.

AWS CLI

Untuk mengambil daftar grup

describe-groupsContoh berikut mencantumkan grup yang terkait dengan WorkDocs organisasi Amazon yang ditentukan.


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

Output:


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

Untuk informasi selengkapnya, lihat Memulai Amazon WorkDocs di Panduan WorkDocs Administrasi Amazon.

Untuk API detailnya, lihat DescribeGroupsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-notification-subscriptions.

AWS CLI

Untuk mengambil daftar langganan notifikasi

describe-notification-subscriptionsContoh berikut mengambil langganan notifikasi untuk organisasi Amazon WorkDocs yang ditentukan.


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

Output:


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

Untuk informasi selengkapnya, lihat Berlangganan Pemberitahuan di Panduan WorkDocs Pengembang Amazon.

Untuk API detailnya, lihat DescribeNotificationSubscriptionsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-resource-permissions.

AWS CLI

Untuk mendapatkan daftar izin untuk sumber daya

Contoh ini mengembalikan daftar izin untuk sumber daya tertentu (dokumen atau folder).

Perintah:


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

Output:


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

Untuk API detailnya, lihat DescribeResourcePermissionsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandescribe-users.

AWS CLI

Untuk mengambil detail untuk pengguna tertentu

Contoh ini mengambil rincian untuk semua pengguna dalam organisasi tertentu.

Perintah:


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

Output:


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

Untuk API detailnya, lihat DescribeUsersdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-document-path.

AWS CLI

Untuk mengambil informasi jalur dokumen

Contoh ini mengambil informasi jalur (hierarki dari folder root) untuk dokumen yang ditentukan, dan menyertakan nama folder induk.

Perintah:


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

Output:


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

Untuk API detailnya, lihat GetDocumentPathdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-document-version.

AWS CLI

Untuk mengambil metadata versi untuk dokumen tertentu

Contoh ini mengambil metadata versi untuk dokumen yang ditentukan, termasuk sumber URL dan metadata kustom.

Perintah:


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

Output:


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

Untuk API detailnya, lihat GetDocumentVersiondi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-document.

AWS CLI

Untuk mengambil detail dokumen

Contoh ini mengambil rincian dokumen yang ditentukan.

Perintah:


aws workdocs get-document --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65

Output:


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

Untuk API detailnya, lihat GetDocumentdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-folder-path.

AWS CLI

Untuk mengambil informasi jalur untuk folder

Contoh ini mengambil informasi jalur (hierarki dari folder root) untuk folder yang ditentukan, dan menyertakan nama folder induk.

Perintah:


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

Output:


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

Untuk API detailnya, lihat GetFolderPathdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-folder.

AWS CLI

Untuk mengambil metadata untuk folder

Contoh ini mengambil metadata untuk folder tertentu.

Perintah:


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

Output:


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

Untuk API detailnya, lihat GetFolderdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-resources.

AWS CLI

Untuk mengambil sumber daya bersama

get-resourcesContoh berikut mengambil sumber daya yang dibagikan dengan WorkDocs pengguna Amazon yang ditentukan.


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

Output:


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

Untuk informasi selengkapnya, lihat Berbagi File dan Folder di Panduan WorkDocs Pengguna Amazon.

Untuk API detailnya, lihat GetResourcesdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakaninitiate-document-version-upload.

AWS CLI

Untuk memulai upload versi dokumen

initiate-document-uploadContoh berikut membuat objek dokumen baru dan objek versi.


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

Output:


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

Untuk API detailnya, lihat InitiateDocumentVersionUploaddi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanremove-all-resource-permissions.

AWS CLI

Untuk menghapus semua izin dari sumber daya tertentu

Contoh ini menghapus semua izin dari sumber daya yang ditentukan.

Perintah:


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

Output:


None

Untuk API detailnya, lihat RemoveAllResourcePermissionsdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanremove-resource-permission.

AWS CLI

Untuk menghapus izin dari sumber daya

Contoh ini menghapus izin dari sumber daya untuk prinsipal yang ditentukan.

Perintah:


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

Output:


None

Untuk API detailnya, lihat RemoveResourcePermissiondi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-document-version.

AWS CLI

Untuk mengubah status versi dokumen menjadi Aktif

Contoh ini mengubah status versi dokumen menjadi Aktif.

Perintah:


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

Output:


None

Untuk API detailnya, lihat UpdateDocumentVersiondi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-document.

AWS CLI

Untuk memperbarui dokumen

Contoh ini memperbarui nama dokumen dan folder induk.

Perintah:


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

Output:


None

Untuk API detailnya, lihat UpdateDocumentdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-folder.

AWS CLI

Untuk memperbarui folder

Contoh ini memperbarui nama folder dan folder induk.

Perintah:


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

Output:


None

Untuk API detailnya, lihat UpdateFolderdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanupdate-user.

AWS CLI

Untuk memperbarui pengguna

Contoh ini memperbarui zona waktu untuk pengguna tertentu.

Perintah:


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

Output:


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

Untuk API detailnya, lihat UpdateUserdi Referensi AWS CLI Perintah.

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

AWS WAFV2

Amazon WorkMail