다음 코드 예제에서는 Amazon WorkDocs에서 AWS Command Line Interface를 사용하여 작업을 수행하고 일반적인 시나리오를 구현하는 방법을 보여 줍니다.
작업은 대규모 프로그램에서 발췌한 코드이며 컨텍스트에 맞춰 실행해야 합니다. 작업은 관련 시나리오의 컨텍스트에 따라 표시되며, 개별 서비스 함수를 직접적으로 호출하는 방법을 보여줍니다.
각 예시에는 전체 소스 코드에 대한 링크가 포함되어 있으며, 여기에서 컨텍스트에 맞춰 코드를 설정하고 실행하는 방법에 대한 지침을 찾을 수 있습니다.
주제
작업
다음 코드 예시에서는 abort-document-version-upload
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
문서 버전 업로드를 중지하는 방법
이 예제에서는 이전에 시작된 문서 버전 업로드를 중지합니다.
명령:
aws workdocs abort-document-version-upload --document-id
feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2
--version-id1536773972914-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
섹션을 참조하세요.
-
다음 코드 예시에서는 add-resource-permissions
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
리소스에 대한 권한을 추가하는 방법
이 예제에서는 지정된 보안 주체에 대한 리소스에 권한을 추가합니다.
명령:
aws workdocs add-resource-permissions --resource-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--principalsId=anonymous,Type=ANONYMOUS,Role=VIEWER
출력:
{ "ShareResults": [ { "PrincipalId": "anonymous", "Role": "VIEWER", "Status": "SUCCESS", "ShareId": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65", "StatusMessage": "" } ] }
-
API 세부 정보는 AWS CLI 명령 참조의 RespondToAuthChallenge
섹션을 참조하세요.
-
다음 코드 예시에서는 create-comment
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
새 주석을 추가하는 방법
이 예제에서는 지정된 문서 버전에 새 주석을 추가합니다.
명령:
aws workdocs create-comment --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--version-id1521672507741-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 명령 참조의 CreateOpsItem
섹션을 참조하세요.
-
다음 코드 예시에서는 create-custom-metadata
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
사용자 지정 메타데이터 업데이트
이 예제에서는 지정된 문서에 대한 사용자 지정 메타데이터를 만듭니다.
명령:
aws workdocs create-custom-metadata --resource-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--custom-metadataKeyName1=example,KeyName2=example2
출력:
None
-
API 세부 정보는 AWS CLI 명령 참조의 CreateSecurityGroup
섹션을 참조하세요.
-
다음 코드 예시에서는 create-folder
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
폴더 생성
이 예제에서는 폴더를 생성합니다.
명령:
aws workdocs create-folder --name
documents
--parent-folder-id1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
출력:
{ "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 명령 참조의 CreatePolicy
섹션을 참조하세요.
-
다음 코드 예시에서는 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
\ --protocolHTTPS
\ --subscription-typeALL
\ --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
--usernameexampleUser2
--email-addressexampleUser2@site.awsapps.com
--given-nameexample2Name
--surnameexample2Surname
--passwordexamplePa$$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
섹션을 참조하세요.
-
다음 코드 예시에서는 delete-comment
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
문서 버전에서 지정된 주석 삭제
이 예제에서는 지정된 문서 버전에서 지정된 주석을 삭제합니다.
명령:
aws workdocs delete-comment --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--version-id1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
--comment-id1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5
출력:
None
-
API 세부 정보는 AWS CLI 명령 참조의 DeleteArchive
섹션을 참조하세요.
-
다음 코드 예시에서는 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-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-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-idd-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
를 참조하세요.
-
다음 코드 예시에서는 describe-activities
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
사용자 활동 목록 가져오기
이 예제에서는 지정된 조직에 대한 최신 사용자 활동 목록을 반환하고, 최근 두 활동에 대한 제한이 설정됩니다.
명령:
aws workdocs describe-activities --organization-id
d-926726012c
--limit2
출력:
{ "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-id1521672507741-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
--fieldsSOURCE
출력:
{ "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
--sortDATE
--orderASCENDING
--typeALL
출력:
{ "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 d
e
scribe-groups \ --search-query "e" \ --organization-idd-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-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
섹션 섹션을 참조하세요.
-
다음 코드 예시에서는 get-document-path
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
문서의 경로 정보 검색
이 예제에서는 지정된 문서의 경로 정보(루트 폴더의 계층 구조)를 검색하고 상위 폴더의 이름을 포함합니다.
명령:
aws workdocs get-document-path --document-id
d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65
--fieldsNAME
출력:
{ "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-id1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
--fieldsSOURCE
--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-folder-path
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
폴더의 경로 정보 검색
이 예제에서는 지정된 폴더의 경로 정보(루트 폴더의 계층 구조)를 검색하고 상위 폴더의 이름을 포함합니다.
명령:
aws workdocs get-folder-path --folder-id
50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
--fieldsNAME
출력:
{ "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-resources
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
공유 리소스 검색
다음
get-resources
예제에서는 지정된 Amazon WorkDocs 사용자와 공유된 리소스를 검색합니다.aws workdocs get-resources \ --user-id
"S-1-1-11-1111111111-2222222222-3333333333-3333"
\ --collection-typeSHARED_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-ideacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189
출력:
{ "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-resource-permission
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
리소스에서 권한 제거
이 예제에서는 지정된 주체에 대한 리소스에서 권한을 제거합니다.
명령:
aws workdocs remove-resource-permission --resource-id
1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
--principal-idanonymous
출력:
None
-
API 세부 정보는 AWS CLI 명령 참조의 RemoveResourcePermission
섹션을 참조하세요.
-
다음 코드 예시에서는 update-document-version
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
문서 버전 상태를 활성으로 변경
이 예제에서는 문서 버전의 상태를 활성으로 변경합니다.
명령:
aws workdocs update-document-version --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--version-id1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920
--version-statusACTIVE
출력:
None
-
API 세부 정보는 AWS CLI 명령 참조의 UpdateDocumentVersion
섹션을 참조하세요.
-
다음 코드 예시에서는 update-document
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
문서 업데이트
이 예제에서는 문서의 이름과 상위 폴더를 업데이트합니다.
명령:
aws workdocs update-document --document-id
15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3
--nameupdatedDoc
--parent-folder-id50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
출력:
None
-
API 세부 정보는 AWS CLI 명령 참조의 UpdateDocument
섹션을 참조하세요.
-
다음 코드 예시에서는 update-folder
을 사용하는 방법을 보여 줍니다.
- AWS CLI
-
폴더 업데이트
이 예제에서는 폴더의 이름과 상위 폴더를 업데이트합니다.
명령:
aws workdocs update-folder --folder-id
50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08
--nameexampleFolder1
--parent-folder-id1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678
출력:
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
섹션을 참조하세요.
-