Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
workdocs-ag-009	workdocs-ag.pdf	9	assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance proﬁle that is attached to the instance. An instance proﬁle contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, deﬁnes their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most Managing access using policies 23 Amazon WorkDocs Administration Guide policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies deﬁne permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Deﬁne custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Resource-based policies Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a speciﬁc resource. For the resource where the policy is attached, the policy deﬁnes what actions a speciﬁed principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Managing access using policies 24 Amazon WorkDocs Administration Guide Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions
workdocs-ag-010	workdocs-ag.pdf	10	To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal ﬁeld are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the eﬀective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Managing access using policies 25 Amazon WorkDocs Administration Guide Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Note Amazon WorkDocs doesn't support Service Control Policies for Slack Organizations. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How Amazon WorkDocs works with IAM Before you use IAM to manage access to Amazon WorkDocs, you need to understand which IAM features are available to use with Amazon WorkDocs. To get a high-level view of how Amazon WorkDocs and other AWS services work with IAM, see AWS services that work with IAM in the IAM User Guide. Topics • Amazon WorkDocs identity-based policies • Amazon WorkDocs resource-based policies • Authorization based on Amazon WorkDocs tags • Amazon WorkDocs IAM roles How Amazon WorkDocs works with IAM 26 Amazon WorkDocs Administration Guide Amazon WorkDocs identity-based policies With IAM identity-based policies, you can specify allowed or denied actions. Amazon WorkDocs supports speciﬁc actions. To learn about the elements that you use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide. Actions Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. The Action element of a JSON policy describes the actions that you can use to allow or deny access in a policy. Policy actions usually have the same name as the associated AWS API operation. There are some exceptions, such as permission-only actions that don't have a matching API operation. There are also some operations that require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. Policy actions in Amazon WorkDocs use the following preﬁx before the action: workdocs:. For example, to grant someone permission to run the Amazon WorkDocs DescribeUsers API operation, you include the workdocs:DescribeUsers action in their policy. Policy statements must include either an Action or NotAction element. Amazon WorkDocs deﬁnes its own set of actions that describe tasks that you can perform with this service. To specify multiple actions in a single statement, separate them with
workdocs-ag-011	workdocs-ag.pdf	11	require multiple actions in a policy. These additional actions are called dependent actions. Include actions in a policy to grant permissions to perform the associated operation. Policy actions in Amazon WorkDocs use the following preﬁx before the action: workdocs:. For example, to grant someone permission to run the Amazon WorkDocs DescribeUsers API operation, you include the workdocs:DescribeUsers action in their policy. Policy statements must include either an Action or NotAction element. Amazon WorkDocs deﬁnes its own set of actions that describe tasks that you can perform with this service. To specify multiple actions in a single statement, separate them with commas as follows: "Action": [ "workdocs:DescribeUsers", "workdocs:CreateUser" You can specify multiple actions using wildcards (). For example, to specify all actions that begin with the word Describe, include the following action: "Action": "workdocs:Describe" Note To ensure backward compatibility, include the zocalo action. For example: How Amazon WorkDocs works with IAM 27 Amazon WorkDocs Administration Guide "Action": [ "zocalo:", "workdocs:" ], To see a list of Amazon WorkDocs actions, see Actions deﬁned by Amazon WorkDocs in the IAM User Guide. Resources Amazon WorkDocs does not support specifying resource ARNs in a policy. Condition keys Amazon WorkDocs does not provide any service-speciﬁc condition keys, but it does support using some global condition keys. To see all AWS global condition keys, see AWS global condition context keys in the IAM User Guide. Examples To view examples of Amazon WorkDocs identity-based policies, see Amazon WorkDocs identity- based policy examples. Amazon WorkDocs resource-based policies Amazon WorkDocs does not support resource-based policies. Authorization based on Amazon WorkDocs tags Amazon WorkDocs does not support tagging resources or controlling access based on tags. Amazon WorkDocs IAM roles An IAM role is an entity within your AWS account that has speciﬁc permissions. Using temporary credentials with Amazon WorkDocs We strongly recommend using temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling AWS STS API operations such as AssumeRole or GetFederationToken. How Amazon WorkDocs works with IAM 28 Amazon WorkDocs Administration Guide Amazon WorkDocs supports using temporary credentials. Service-linked roles Service-linked roles allow AWS services to access resources in other services to complete an action on your behalf. Service-linked roles appear in your IAM account and are owned by the service. An IAM administrator can view but not edit the permissions for service-linked roles. Amazon WorkDocs does not support service-linked roles. Service roles This feature allows a service to assume a service role on your behalf. This role allows the service to access resources in other services to complete an action on your behalf. Service roles appear in your IAM account and are owned by the account. This means that an IAM administrator can change the permissions for this role. However, doing so might break the functionality of the service. Amazon WorkDocs does not support service roles. Amazon WorkDocs identity-based policy examples Note For greater security, create federated users instead of IAM users whenever possible. By default, IAM users and roles don't have permission to create or modify Amazon WorkDocs resources. They also can't perform tasks using the AWS Management Console, AWS CLI, or AWS API. An IAM administrator must create IAM policies that grant users and roles permission to perform speciﬁc API operations on the speciﬁed resources they need. The administrator must then attach those policies to the IAM users or groups that require those permissions. Note To ensure backward compatibility, include the zocalo action in your policies. For example: { "Version": "2012-10-17", "Statement": [ Identity-based policy examples 29 Administration Guide Amazon WorkDocs { "Sid": "VisualEditor0", "Effect": "Deny", "Action": [ "zocalo:", "workdocs:" ], "Resource": "*" } ] } To learn how to create an IAM identity-based policy using these example JSON policy documents, see Creating policies on the JSON tab in the IAM User Guide. Topics • Policy best practices • Using the Amazon WorkDocs console • Allow users to view their own permissions • Allow users read-only access to Amazon WorkDocs resources • More Amazon WorkDocs identity-based policy examples Policy best practices Identity-based policies determine whether someone can create, access, or delete Amazon WorkDocs resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply
workdocs-ag-012	workdocs-ag.pdf	12	for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on Identity-based policy examples 30 Amazon WorkDocs Administration Guide speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the Amazon WorkDocs console To access the Amazon WorkDocs console, you must have a minimum set of permissions. Those permissions must allow you to list and view the details of the Amazon WorkDocs resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for IAM user or role entities. To ensure that those entities can use the Amazon WorkDocs console, also attach the following AWS managed policies to the entities. For more information attaching policies, see Adding permissions to a user in the IAM User Guide. • AmazonWorkDocsFullAccess • AWSDirectoryServiceFullAccess • AmazonEC2FullAccess Identity-based policy examples 31 Amazon WorkDocs Administration Guide These policies grant a user full access to Amazon WorkDocs resources, AWS Directory Service operations, and the Amazon EC2 operations that Amazon WorkDocs needs in order to work properly. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that you're trying to perform. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], Identity-based policy examples 32 Amazon WorkDocs Administration Guide "Resource": "" } ] } Allow users read-only access to Amazon WorkDocs resources The following AWS managed AmazonWorkDocsReadOnlyAccess policy grants an IAM user read- only access to Amazon WorkDocs resources. The policy gives the user access to all of the Amazon WorkDocs Describe operations. Access to the two Amazon EC2 operations are necessary so Amazon WorkDocs can obtain a list of your VPCs and subnets. Access to the AWS Directory Service DescribeDirectories operation is needed to obtain information about your AWS Directory Service directories. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workdocs:Describe", "ds:DescribeDirectories", "ec2:DescribeVpcs", "ec2:DescribeSubnets" ], "Resource": "" } ] } More Amazon WorkDocs identity-based policy examples IAM administrators can
workdocs-ag-013	workdocs-ag.pdf	13	The following AWS managed AmazonWorkDocsReadOnlyAccess policy grants an IAM user read- only access to Amazon WorkDocs resources. The policy gives the user access to all of the Amazon WorkDocs Describe operations. Access to the two Amazon EC2 operations are necessary so Amazon WorkDocs can obtain a list of your VPCs and subnets. Access to the AWS Directory Service DescribeDirectories operation is needed to obtain information about your AWS Directory Service directories. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workdocs:Describe", "ds:DescribeDirectories", "ec2:DescribeVpcs", "ec2:DescribeSubnets" ], "Resource": "" } ] } More Amazon WorkDocs identity-based policy examples IAM administrators can create additional policies to allow an IAM role or user to access the Amazon WorkDocs API. For more information, see Authentication and access control for administrative applications in the Amazon WorkDocs Developer Guide. Troubleshooting Amazon WorkDocs identity and access Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with Amazon WorkDocs and IAM. Troubleshooting 33 Amazon WorkDocs Topics Administration Guide • I am not authorized to perform an action in Amazon WorkDocs • I am not authorized to perform iam:PassRole • I want to allow people outside of my AWS account to access my Amazon WorkDocs resources I am not authorized to perform an action in Amazon WorkDocs If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance. Your administrator is the person that provided you with your user name and password. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to Amazon WorkDocs. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in Amazon WorkDocs. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I want to allow people outside of my AWS account to access my Amazon WorkDocs resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support Troubleshooting 34 Amazon WorkDocs Administration Guide resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether Amazon WorkDocs supports these features, see How Amazon WorkDocs works with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Logging and monitoring in Amazon WorkDocs Amazon WorkDocs site administrators can view and export the activity feed for an entire site. They can also use AWS CloudTrail to capture events from the Amazon WorkDocs console. Topics • Exporting the site-wide activity feed • Using AWS CloudTrail to log Amazon WorkDocs API calls Exporting the site-wide activity feed Admins can view and export the activity feed for an entire site. To use this feature, you must ﬁrst install Amazon WorkDocs Companion. To install Amazon WorkDocs Companion, see Apps & Integrations for Amazon WorkDocs. To view and export a site-wide activity feed 1. In the web application, choose Activity. 2. Choose Filter, then move the Site-wide activity slider to turn the ﬁlter on. 3. Select Activity Type ﬁlters and choose Date Modiﬁed settings as needed, then choose Apply. Logging and monitoring 35 Amazon WorkDocs Administration Guide 4. When the ﬁltered activity feed results appear, search by ﬁle, folder, or user name to narrow your results. You can
workdocs-ag-014	workdocs-ag.pdf	14	for an entire site. To use this feature, you must ﬁrst install Amazon WorkDocs Companion. To install Amazon WorkDocs Companion, see Apps & Integrations for Amazon WorkDocs. To view and export a site-wide activity feed 1. In the web application, choose Activity. 2. Choose Filter, then move the Site-wide activity slider to turn the ﬁlter on. 3. Select Activity Type ﬁlters and choose Date Modiﬁed settings as needed, then choose Apply. Logging and monitoring 35 Amazon WorkDocs Administration Guide 4. When the ﬁltered activity feed results appear, search by ﬁle, folder, or user name to narrow your results. You can also add or remove ﬁlters as needed. 5. Choose Export to export the activity feed to .csv and .json ﬁles on your desktop. The system exports the ﬁles to one of the following locations: • Windows – WorkDocsDownloads folder in your PC's Downloads folder • macOS – /users/username/WorkDocsDownloads/folder The exported ﬁle reﬂects any ﬁlters that you apply. Note Users who are not administrators can view and export the activity feed for their own content only. For more information, see Viewing the Activity Feed in the Amazon WorkDocs User Guide. Using AWS CloudTrail to log Amazon WorkDocs API calls You can use AWS CloudTrail; to log Amazon WorkDocs API calls. CloudTrail provides a record of actions taken by a user, role, or an AWS service in Amazon WorkDocs. CloudTrail captures all API calls for Amazon WorkDocs as events, including calls from the Amazon WorkDocs console and from code calls to the Amazon WorkDocs APIs. If you create a trail, you can enable continuous delivery of CloudTrail events to an Amazon S3 bucket, including events for Amazon WorkDocs. If you don't create a trail, you can still view the most recent events in the CloudTrail console in Event history. The information collected by CloudTrail includes requests, the IP addresses from which the requests were made, the users who made the requests, and the request dates. For more information about CloudTrail, see the AWS CloudTrail User Guide. Amazon WorkDocs information in CloudTrail CloudTrail is enabled on your AWS account when you create the account. When activity occurs in Amazon WorkDocs, that activity is recorded in a CloudTrail event along with other AWS service events in Event history. You can view, search, and download recent events in your AWS account. For more information, see Viewing events with CloudTrail event history. CloudTrail logging 36 Amazon WorkDocs Administration Guide For an ongoing record of events in your AWS account, including events for Amazon WorkDocs, create a trail. A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. By default, when you create a trail in the console, the trail applies to all regions. The trail logs events from all regions in the AWS partition and delivers the log ﬁles to the Amazon S3 bucket that you specify. Additionally, you can conﬁgure other AWS services to further analyze and act upon the event data collected in CloudTrail logs. For more information, see: • Overview for creating a trail • CloudTrail supported services and integrations • Conﬁguring Amazon SNS notiﬁcations for CloudTrail • Receiving CloudTrail log ﬁles from multiple Regions and Receiving CloudTrail log ﬁles from multiple accounts All Amazon WorkDocs actions are logged by CloudTrail and are documented in the Amazon WorkDocs API Reference. For example, calls to the CreateFolder, DeactivateUser and UpdateDocument sections generate entries in the CloudTrail log ﬁles. Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root or IAM user credentials. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. For more information, see the CloudTrail userIdentity element. Understanding Amazon WorkDocs log ﬁle entries A trail is a conﬁguration that enables delivery of events as log ﬁles to an Amazon S3 bucket that you specify. CloudTrail log ﬁles contain one or more log entries. An event represents a single request from any source and includes information about the requested action, the date and time of the action, request parameters, and so on. CloudTrail log ﬁles are not an ordered stack trace of the public API calls, so they do not appear in any speciﬁc order. Amazon WorkDocs generates diﬀerent types of CloudTrail entries , those from the control plane and those from the data plane. The important diﬀerence between the two is that the user identity CloudTrail logging 37 Amazon WorkDocs Administration Guide for control plane entries is an IAM user. The user identity for data plane entries is the Amazon WorkDocs directory user. Note For greater security, create federated users instead of IAM users whenever possible. Sensitive information, such as passwords, authentication tokens, ﬁle
workdocs-ag-015	workdocs-ag.pdf	15	are not an ordered stack trace of the public API calls, so they do not appear in any speciﬁc order. Amazon WorkDocs generates diﬀerent types of CloudTrail entries , those from the control plane and those from the data plane. The important diﬀerence between the two is that the user identity CloudTrail logging 37 Amazon WorkDocs Administration Guide for control plane entries is an IAM user. The user identity for data plane entries is the Amazon WorkDocs directory user. Note For greater security, create federated users instead of IAM users whenever possible. Sensitive information, such as passwords, authentication tokens, ﬁle comments, and ﬁle contents are redacted in the log entries. These show up as HIDDEN_DUE_TO_SECURITY_REASONS in the CloudTrail logs. These show up as HIDDEN_DUE_TO_SECURITY_REASONS in the CloudTrail logs. The following example shows two CloudTrail log entries for Amazon WorkDocs: the ﬁrst record is for a control plane action and the second is for a data plane action. { Records : [ { "eventVersion" : "1.01", "userIdentity" : { "type" : "IAMUser", "principalId" : "user_id", "arn" : "user_arn", "accountId" : "account_id", "accessKeyId" : "access_key_id", "userName" : "user_name" }, "eventTime" : "event_time", "eventSource" : "workdocs.amazonaws.com", "eventName" : "RemoveUserFromGroup", "awsRegion" : "region", "sourceIPAddress" : "ip_address", "userAgent" : "user_agent", "requestParameters" : { "directoryId" : "directory_id", "userSid" : "user_sid", "group" : "group" }, "responseElements" : null, "requestID" : "request_id", CloudTrail logging 38 Amazon WorkDocs Administration Guide "eventID" : "event_id" }, { "eventVersion" : "1.01", "userIdentity" : { "type" : "Unknown", "principalId" : "user_id", "accountId" : "account_id", "userName" : "user_name" }, "eventTime" : "event_time", "eventSource" : "workdocs.amazonaws.com", "awsRegion" : "region", "sourceIPAddress" : "ip_address", "userAgent" : "user_agent", "requestParameters" : { "AuthenticationToken" : "-redacted-" }, "responseElements" : null, "requestID" : "request_id", "eventID" : "event_id" } ] } Compliance validation for Amazon WorkDocs To learn whether an AWS service is within the scope of speciﬁc compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. Compliance validation 39 Amazon WorkDocs Administration Guide • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. Resilience in Amazon WorkDocs The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between Availability Zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Resilience 40 Amazon WorkDocs Administration Guide Infrastructure security in Amazon WorkDocs As a managed service, Amazon WorkDocs is protected by the AWS global network security procedures. For more information, see Infrastructure security in AWS Identity and Access Management in the IAM User Guide and Best Practices for Security, Identity,
workdocs-ag-016	workdocs-ag.pdf	16	With Availability Zones, you can design and operate applications and databases that automatically fail over between Availability Zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. Resilience 40 Amazon WorkDocs Administration Guide Infrastructure security in Amazon WorkDocs As a managed service, Amazon WorkDocs is protected by the AWS global network security procedures. For more information, see Infrastructure security in AWS Identity and Access Management in the IAM User Guide and Best Practices for Security, Identity, & Compliance in the AWS Architecture Center. You use AWS published API calls to access Amazon WorkDocs through the network. Clients must support Transport Layer Security (TLS) 1.2, and we recommend using TLS 1.3. Clients must also support cipher suites with perfect forward secrecy such as Ephemeral Diﬃe-Hellman or Elliptic Curve Ephemeral Diﬃe-Hellman. Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. Infrastructure security 41 Amazon WorkDocs Administration Guide Getting started with Amazon WorkDocs Amazon WorkDocs uses a directory to store and manage organization information for your users and their documents. In turn, you attach a directory to a site when you provision that site. When you do, an Amazon WorkDocs feature called Auto activation adds the users in the directory to the site as managed users, meaning they don't need separate credentials to log in to your site, and they can share and collaborate on ﬁles. Each user has 1 TB of storage unless they purchase more. You no longer need to add and activate users manually, though you still can. You can also change user roles and permissions whenever you need to. For more information about doing that, see Inviting and managing Amazon WorkDocs users, later in this guide. If you need to create directories, you can: • Create a Simple AD directory. • Create an AD Connector directory to connect to your on-premises directory. • Enable Amazon WorkDocs to work with an existing AWS directory. • Have Amazon WorkDocs create a directory for you. You can also create a trust relationship between your AD directory and an AWS Managed Microsoft AD Directory. Note If you belong to a compliance program such as PCI, FedRAMP, or DoD, you must set up an AWS Managed Microsoft AD Directory to meet compliance requirements. The steps in this section explain how to use an existing Microsoft AD Directory. For information about creating a Microsoft AD Directory, see AWS Managed Microsoft AD in the AWS Directory Service Administration Guide. Contents • Creating an Amazon WorkDocs site • Enabling single sign-on • Enabling multi-factor authentication • Promoting a user to administrator 42 Amazon WorkDocs Administration Guide Creating an Amazon WorkDocs site The steps in the following sections explain how to set up a new Amazon WorkDocs site. Tasks • Before you begin • Creating an Amazon WorkDocs site Before you begin You must have the following items before you create an Amazon WorkDocs site. • An AWS account for creating and administering Amazon WorkDocs sites. However, users do not need an AWS account to connect to and use Amazon WorkDocs. For more information, see Prerequisites for Amazon WorkDocs. • If you plan to use Simple AD, you must meet the prerequisites identiﬁed in Simple AD Prerequisites in the AWS Directory Service Administration Guide. • An AWS Managed Microsoft AD Directory if you belong to a compliance program such as PCI, FedRAMP, or DoD. The steps in this section explain how to use an existing Microsoft AD Directory. For information about creating a Microsoft AD Directory, see AWS Managed Microsoft AD in the AWS Directory Service Administration Guide. • Proﬁle information for the administrator, including ﬁrst and last name, and an email address. Creating an Amazon WorkDocs site Follow these steps to create an Amazon WorkDocs site in minutes. To create the Amazon WorkDocs site 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. On the console's Home page, under Create a WorkDocs site, choose Get Started now. —OR— In the navigation pane, choose My sites, and on the Manage your WorkDocs sites page, choose Create a WorkDocs site. Creating an Amazon WorkDocs site 43 Amazon WorkDocs Administration Guide What happens next depends on whether you have a directory. • If you have a directory, The Select a directory page appears and allows you to choose an existing directory or create a directory. • If you don't have a directory, the Set up a directory type page appears and
workdocs-ag-017	workdocs-ag.pdf	17	WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. On the console's Home page, under Create a WorkDocs site, choose Get Started now. —OR— In the navigation pane, choose My sites, and on the Manage your WorkDocs sites page, choose Create a WorkDocs site. Creating an Amazon WorkDocs site 43 Amazon WorkDocs Administration Guide What happens next depends on whether you have a directory. • If you have a directory, The Select a directory page appears and allows you to choose an existing directory or create a directory. • If you don't have a directory, the Set up a directory type page appears and allows you to create a Simple AD or AD Connector directory The following steps explain how to do both tasks. To use an existing directory 1. Open the Available directories list and choose the directory that you want to use. 2. Choose Enable directory. To create a directory 1. Repeat steps 1 and 2 above. At this point, what you do depends on whether you want to use Simple AD or create an AD Connector. To use Simple AD a. Choose Simple AD, then choose Next. The Create Simple AD site page appears. b. Under Access point, in the Site URL box, enter the URL for the site. c. Under Set WorkDocs administrator, enter the administrator's email address, ﬁrst name, and last name. d. As needed, complete the options under Directory details and VPC conﬁguration. e. Choose Create Simple AD site. To create an AD Connector directory a. Choose AD Connector, then choose Next. Creating an Amazon WorkDocs site 44 Amazon WorkDocs Administration Guide The Create AD Connector site page appears. b. Complete all the ﬁelds under Directory details. c. Under Access point, in the Site URL box, enter your site's URL. d. As desired, complete the optional ﬁelds under VPC conﬁguration. e. Choose Create AD Connector site. Amazon WorkDocs does the following: • If you chose Set up a VPC on my behalf in step 4 above, Amazon WorkDocs creates a VPC for you. A directory in the VPC stores user and Amazon WorkDocs site information. • If you used Simple AD, Amazon WorkDocs creates a Directory User and sets that user as an Amazon WorkDocs administrator. If you created an AD Connector directory, Amazon WorkDocs sets the existing directory user that you provided as a WorkDocs administrator. • If you used an existing directory, Amazon WorkDocs prompts you to enter the user name of the Amazon WorkDocs administrator. The user must be a member of the directory. Note Amazon WorkDocs doesn't notify users about the new site. You need to communicate the URL to them, and let them know that they don't need a separate login to use the site. Enabling single sign-on AWS Directory Service allows users to access Amazon WorkDocs from a computer joined to the same directory with which Amazon WorkDocs is registered, without entering credentials separately. Amazon WorkDocs administrators can enable single sign-on using the AWS Directory Service console. For more information, see Single sign-on in the AWS Directory Service Administration Guide. After the Amazon WorkDocs administrator enables single sign-on, the Amazon WorkDocs site users might also need to modify their web browser settings to allow single sign-on. For more information, see Single sign-on for IE and Chrome and Single sign-on for Firefox in the AWS Directory Service Administration Guide. Enabling single sign-on 45 Amazon WorkDocs Administration Guide Enabling multi-factor authentication You use the AWS Directory Services Console at https://console.aws.amazon.com/ directoryservicev2/ to enable multi-factor authentication for your AD Connector directory. To enable MFA, you must have an MFA solution that is a Remote authentication dial-in user service (RADIUS) server, or you must have an MFA plugin to a RADIUS server already implemented in your on-premises infrastructure. Your MFA solution should implement One Time Passcodes (OTP) that users obtain from a hardware device or from software running on a device such as a cell phone. RADIUS is an industry-standard client/server protocol that provides authentication, authorization, and accounting management to enable users to connect to network services. AWS Managed Microsoft AD includes a RADIUS client that connects to the RADIUS server upon which you have implemented your MFA solution. Your RADIUS server validates the username and OTP code. If your RADIUS server successfully validates the user, AWS Managed Microsoft AD then authenticates the user against AD. Upon successful AD authentication, users can then access the AWS application. Communication between the AWS Managed Microsoft AD RADIUS client and your RADIUS server require you to conﬁgure AWS security groups that enable communication over port 1812. For more information, see Enable multi-factor authentication for AWS Managed Microsoft AD in the AWS Directory Service Administration Guide. Note Multi-factor authentication is not available for Simple AD directories. Promoting a user to administrator You use the Amazon WorkDocs console to promote a
workdocs-ag-018	workdocs-ag.pdf	18	OTP code. If your RADIUS server successfully validates the user, AWS Managed Microsoft AD then authenticates the user against AD. Upon successful AD authentication, users can then access the AWS application. Communication between the AWS Managed Microsoft AD RADIUS client and your RADIUS server require you to conﬁgure AWS security groups that enable communication over port 1812. For more information, see Enable multi-factor authentication for AWS Managed Microsoft AD in the AWS Directory Service Administration Guide. Note Multi-factor authentication is not available for Simple AD directories. Promoting a user to administrator You use the Amazon WorkDocs console to promote a user to administrator. Follow these steps. To promote a user to administrator 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. In the navigation pane, choose My sites. The Manage your WorkDocs Sites page appears. 3. Select the button next to the desired site, choose Actions, then choose Set an administrator. Enabling multi-factor authentication 46 Amazon WorkDocs Administration Guide The Set WorkDocs administrator dialog box appears. 4. In the Username box, enter the user name of the person that you want to promote, then choose Set administrator. You can also use the Amazon WorkDocs site admin control panel to demote an administrator. For more information, see Editing users. Promoting a user to administrator 47 Amazon WorkDocs Administration Guide Managing Amazon WorkDocs from the AWS console You use these tools to manage your Amazon WorkDocs sites: • The AWS console at https://console.aws.amazon.com/zocalo/. • The site admin control panel, available to administrators on all Amazon WorkDocs sites. Each of those tools provides a diﬀerent set of actions, and the topics in this section explain the actions provided by the AWS console. For information about the site admin control panel, see Managing Amazon WorkDocs from the site admin control panel. Setting site administrators If you're an administrator, you can give users access to the site control panel and the actions that it provides. To set an administrator 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. In the navigation pane, choose My sites. The Manage your WorkDocs sites page appears and displays a list of your sites. 3. Choose the button next to the site for which you want to set an administrator. 4. Open the Actions list and choose Set an administrator. The Set WorkDocs administrator dialog box appears. 5. In the Username box, enter the new administrator's name, then choose Set administrator. Resending invitation emails You can resend an invitation email at any time. To resend the invitation email 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. In the navigation pane, choose My sites. Setting site administrators 48 Amazon WorkDocs Administration Guide The Manage your WorkDocs sites page appears and displays a list of your sites. 3. Choose the button next to the site for which you want to resend the email. 4. Open the Actions list and choose Resend invitation email. A success message in a green banner appears at the top of the page. Managing multifactor authentication You can enable multi-factor authentication after you create an Amazon WorkDocs site. For more information about authentication, see Enabling multi-factor authentication. Setting site URLs Note If you followed the site creation process in Getting started with Amazon WorkDocs, you entered a site URL. As a result, Amazon WorkDocs makes the Set site URL command unavailable, because you can only set a URL once. You only follow these steps if you deploy Amazon WorkSpaces and integrate it with Amazon WorkDocs. The Amazon WorkSpaces integration process has you enter a serial number instead of a site URL, so you have to enter a URL after you ﬁnish the integration. For more information about integrating Amazon WorkSpaces and Amazon WorkDocs see Integrate with WorkDocs in the Amazon WorkSpaces User Guide. To set a site URL 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. In the navigation pane, choose My sites. The Manage your WorkDocs sites page appears and displays a list of your sites. 3. Select the site that you integrated with Amazon WorkSpaces. The URL contains the directory ID of your Amazon WorkSpaces instance, such as https://{directory_id}.awsapps.com. 4. Choose the button next to that URL, open the Actions list, and choose Set site URL. The Set site URL dialog box appears. Managing multifactor authentication 49 Amazon WorkDocs Administration Guide 5. In the Site URL box, enter the URL for the site, then choose Set site URL. 6. On the Manage your WorkDocs sites page, choose Refresh to see the new URL. Managing notiﬁcations Note For greater security, create federated users instead of IAM users whenever possible. Notiﬁcations allow IAM users or roles to call the CreateNotiﬁcationSubscription API, which you can use to set your own endpoint for processing the SNS messages that WorkDocs sends. For more information about notiﬁcations, see Setting up
workdocs-ag-019	workdocs-ag.pdf	19	site URL. The Set site URL dialog box appears. Managing multifactor authentication 49 Amazon WorkDocs Administration Guide 5. In the Site URL box, enter the URL for the site, then choose Set site URL. 6. On the Manage your WorkDocs sites page, choose Refresh to see the new URL. Managing notiﬁcations Note For greater security, create federated users instead of IAM users whenever possible. Notiﬁcations allow IAM users or roles to call the CreateNotiﬁcationSubscription API, which you can use to set your own endpoint for processing the SNS messages that WorkDocs sends. For more information about notiﬁcations, see Setting up notiﬁcations for an IAM user or role in the Amazon WorkDocs Developer Guide. You can create and delete notiﬁcations, and the following steps explain how to do both tasks. Note To create a notiﬁcation, you must have your IAM or role ARN. To ﬁnd your IAM ARN, do the following: 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. 3. In the navigation bar, select Users. Select your user name. 4. Under Summary, copy your ARN. To create a notiﬁcation 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. In the navigation pane, choose My sites. The Manage your WorkDocs sites page appears and displays a list of your sites. 3. Choose the button next to the desired site. 4. Open the Actions list and choose Manage notiﬁcations. Managing notiﬁcations 50 Amazon WorkDocs Administration Guide The Manage notiﬁcations page appears. 5. Choose Create notiﬁcation. 6. In the New notiﬁcation dialog box, enter your IAM or role ARN, then choose Create notiﬁcations. To delete a notiﬁcation 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. In the navigation pane, choose My sites. The Manage your WorkDocs sites page appears and displays a list of your sites. 3. Choose the button next to the site that has the notiﬁcation that you want to delete. 4. Open the Actions list and choose Manage notiﬁcations. 5. On the Manage notiﬁcations page, choose the button next to the notiﬁcation that you want to delete, then choose Delete notiﬁcations. Deleting a site You use the Amazon WorkDocs console to delete a site. Warning You lose all ﬁles when you delete a site. Delete a site only if you are sure that this information is no longer needed. To delete a site 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. In the navigation bar, choose My sites. The Manage your WorkDocs sites page appears. 3. Choose the button next to the site that you want to delete, then choose Delete. The Delete site URL dialog box appears. Deleting a site 51 Amazon WorkDocs Administration Guide 4. Optionally, choose Also delete the user directory. Important If you don't provide your own directory for Amazon WorkDocs, we create one for you. When you delete the Amazon WorkDocs site, you are charged for the directory that we create unless you delete that directory or use it for another AWS application. For pricing information, see AWS Directory Service Pricing. 5. In the Site URL box, enter the site URL, then choose Delete. The site is immediately deleted and is no longer available. Deleting a site 52 Amazon WorkDocs Administration Guide Managing Amazon WorkDocs from the site admin control panel You use these tools to manage your Amazon WorkDocs sites: • The site admin control panel, available to administrators on all Amazon WorkDocs sites, and described in the following topics. • The AWS console at https://console.aws.amazon.com/zocalo/. Each of those tools provides a diﬀerent set of actions. The topics in this section explain the actions provided by the site admin control panel. For information about the tasks available in the console, see Managing Amazon WorkDocs from the AWS console. Preferred language settings You can specify the language for email notiﬁcations. To change language settings 1. Under My Account, choose Open admin control panel. 2. For Preferred Language Settings, choose your preferred language. Hancom Online Editing and Oﬃce Online Enable or disable Hancom Online Editing and Oﬃce Online settings from the Admin control panel. For more information, see Enabling collaborative editing. Storage Specify the amount of storage that new users receive. To change storage settings 1. Under My Account, choose Open admin control panel. 2. For Storage, choose Change. Preferred language settings 53 Amazon WorkDocs Administration Guide 3. In the Storage Limit dialog box, choose whether to give new users unlimited or limited storage. 4. Choose Save Changes. Changing the storage setting aﬀects only users that are added after the setting is changed. It does not change the amount of storage allocated to existing users. To change the storage limit for an existing user, see Editing users. IP allow list Amazon WorkDocs site administrators can add IP Allow List settings to restrict site access to an allowed range of IP addresses. You can add
workdocs-ag-020	workdocs-ag.pdf	20	2. For Storage, choose Change. Preferred language settings 53 Amazon WorkDocs Administration Guide 3. In the Storage Limit dialog box, choose whether to give new users unlimited or limited storage. 4. Choose Save Changes. Changing the storage setting aﬀects only users that are added after the setting is changed. It does not change the amount of storage allocated to existing users. To change the storage limit for an existing user, see Editing users. IP allow list Amazon WorkDocs site administrators can add IP Allow List settings to restrict site access to an allowed range of IP addresses. You can add up to 500 IP Allow List settings per site. Note The IP Allow List currently works for IPv4 addresses only. IP address deny-listing is not currently supported. To add an IP range to the IP Allow List 1. Under My Account, choose Open admin control panel. 2. 3. For IP Allow List, choose Change. For Enter CIDR value, enter the Classless Inter-Domain Routing (CIDR) block for the IP address ranges, and choose Add. • To allow access from a single IP address, specify /32 as the CIDR preﬁx. 4. Choose Save Changes. 5. Users who connect to your site from the IP addresses on the IP Allow List are allowed access. Users who attempt to connect to your site from unauthorized IP addresses receive an unauthorized response. Warning If you enter a CIDR value that blocks you from using your current IP address to access the site, a warning message appears. If you choose to continue with the current CIDR value, you IP allow list 54 Amazon WorkDocs Administration Guide will be blocked from accessing the site with your current IP address. This action can only be reversed by contacting AWS Support. Security – Simple ActiveDirectory sites This topic explains the various security settings for Simple ActiveDirectory sites. If you manage sites that use ActiveDirectory connector, see the next section. To use security settings 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. 3. Scroll down to Security and choose Change. The Policy Settings dialog box appears. The following table lists the security settings for Simple ActiveDirectory sites. Setting Description Under Choose your setting for shareable links, select one of the following: Do not allow site-wide or public shareable links Disables link sharing for all users. Allow users to create site-wide shareable links, but do not allow them to create Limits link sharing to just site members. Managed users can create this type of link. public shareable links Allow users to create site-wide shareable links, but only power users can create public shareable links Managed users can create site-wide links, but only power users can create public links. Public links allow access to anyone on the internet. Security – Simple ActiveDirectory sites 55 Amazon WorkDocs Setting Administration Guide Description All managed users can create site-wide & public shareable links Managed users can create public links. Under Auto activation, select or clear the checkbox. Allow all users in your directory to be automatically activated upon their ﬁrst Automatically activates users when they ﬁrst log in to your site. login to your WorkDocs site. Under Who should be allowed to invite new users to your WorkDocs site, select one of the following: Only administrators can invite new users. Only administrators can invite new users. Users can invite new users from anywhere by sharing ﬁles or folders with them. Allows users to invite new users by sharing ﬁles or folders with those users. Users can invite new users from a few speciﬁc domains by sharing ﬁles or folders Users can invite new people from the speciﬁed domains by sharing ﬁles or folders with them. with them. Under Conﬁgure role for new users, select or clear the checkbox. New users from your directory will be Managed users (they are Guest users by Automatically converts new users from your directory into managed users. default) 4. When ﬁnished, choose Save Changes. Security – ActiveDirectory connector sites This topic explains the various security settings for ActiveDirectory connector sites. If you manage sites that use Simple ActiveDirectory, see the previous section. To use security settings 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. Security – ActiveDirectory connector sites 56 Amazon WorkDocs Administration Guide 2. Under Admin, choose Open admin control panel. 3. Scroll down to Security and choose Change. The Policy Settings dialog box appears. The following table lists and describes the security settings for ActiveDirectory connector sites. Setting Description Under Choose your setting for shareable links, select one of the following: Do not allow site-wide or public shareable links When selected, disables link sharing for all users. Allow users to create site-wide shareable links, but do not allow them to
workdocs-ag-021	workdocs-ag.pdf	21	Choose the proﬁle icon in the upper-right corner of the WorkDocs client. Security – ActiveDirectory connector sites 56 Amazon WorkDocs Administration Guide 2. Under Admin, choose Open admin control panel. 3. Scroll down to Security and choose Change. The Policy Settings dialog box appears. The following table lists and describes the security settings for ActiveDirectory connector sites. Setting Description Under Choose your setting for shareable links, select one of the following: Do not allow site-wide or public shareable links When selected, disables link sharing for all users. Allow users to create site-wide shareable links, but do not allow them to create Limits link sharing to just site members. Managed users can create this type of link. public shareable links Allow users to create site-wide shareable links, but only power users can create Managed users can create site-wide links, but only power users can create public links. public shareable links Public links allow access to anyone on the internet. All managed users can create site-wide & public shareable links Managed users can create public links. Under Auto activation, select or clear the checkbox. Allow all users in your directory to be automatically activated upon their ﬁrst Automatically activates users when they ﬁrst log in to your site. login to your WorkDocs site. Under Who should be allowed to activate directory users in your WorkDocs site?, select one of the following: Only administrators can activate new users from your directory. Allows only administrators to activate new directory users. Security – ActiveDirectory connector sites 57 Amazon WorkDocs Setting Administration Guide Description Users can activate new users from your directory by sharing ﬁles or folders with Allows users to activate directory users by sharing ﬁles or folders with the directory them. users. Users can activate new users from a few speciﬁc domains by sharing ﬁles or folders Users can only share ﬁles or folders from users in speciﬁc domains. When you choose with them. this option, you must enter the domains. Under Who should be allowed to invite new users to your WorkDocs site?, select one of the following: Share with external users Note The options below only appear after you choose this setting. Enables administrators and users to invite new external users to your Amazon WorkDocs site. Only administrators can invite new external users Only administrators can invite external users. All managed users can invite new users Enables managed users to invite external users. Only power users can invite new external users. Enables only power users to invite new external users. Under Conﬁgure role for new users, select one or both options. New users from your directory will be Managed users (they are Guest users by Automatically converts new users from your directory into managed users. default) New external users will be Managed users (they are Guest users by default) Automatically converts new external users into managed users. 4. When ﬁnished, choose Save Changes. Security – ActiveDirectory connector sites 58 Amazon WorkDocs Administration Guide Recovery bin retention When a user deletes a ﬁle, Amazon WorkDocs stores the ﬁle in the user’s recycle bin for 30 days. Afterwards, Amazon WorkDocs moves the ﬁles to a temporary recovery bin for 60 days, then deletes them permanently. Only administrators can see the temporary recovery bin. By changing the site-wide data retention policy, site administrators can change the recovery bin retention period to a minimum of zero days and maximum of 365. To change the recovery bin retention period 1. Under My Account, choose Open admin control panel. 2. Next to Recovery bin retention, choose Change. 3. Enter the number of days to retain ﬁles in the recovery bin, and choose Save. Note The default retention period is 60 days. You can use a period of 0–365 days. Administrators can restore user ﬁles from the recovery bin before Amazon WorkDocs deletes them permanently. To restore a user's ﬁle 1. Under My Account, choose Open admin control panel. 2. Under Manage Users, choose the user's folder icon. 3. Under Recovery bin, select the ﬁle(s) to restore, then choose the Recover icon. 4. For Restore ﬁle, choose the location to which to restore the ﬁle, then choose Restore. Manage user settings You can manage settings for users, including changing user roles and inviting, enabling, or disabling users. For more information, see Inviting and managing Amazon WorkDocs users. Recovery bin retention 59 Amazon WorkDocs Administration Guide Deploying Amazon WorkDocs Drive to multiple computers If you have a domain-joined machine ﬂeet, you can use Group Policy Objects (GPO) or System Center Conﬁguration Manager (SCCM) to install the Amazon WorkDocs Drive client. You can download the client from https://amazonworkdocs.com/en/clients . As you go, remember that Amazon WorkDocs Drive requires HTTPS access on port 443 for all AWS IP addresses. You'll also want to conﬁrm that your target systems meet the installation requirements
workdocs-ag-022	workdocs-ag.pdf	22	user roles and inviting, enabling, or disabling users. For more information, see Inviting and managing Amazon WorkDocs users. Recovery bin retention 59 Amazon WorkDocs Administration Guide Deploying Amazon WorkDocs Drive to multiple computers If you have a domain-joined machine ﬂeet, you can use Group Policy Objects (GPO) or System Center Conﬁguration Manager (SCCM) to install the Amazon WorkDocs Drive client. You can download the client from https://amazonworkdocs.com/en/clients . As you go, remember that Amazon WorkDocs Drive requires HTTPS access on port 443 for all AWS IP addresses. You'll also want to conﬁrm that your target systems meet the installation requirements for Amazon WorkDocs Drive. For more information, see Installing Amazon WorkDocs Drive in the Amazon WorkDocs User Guide. Note As a best practice when using GPO or SCCM, install the Amazon WorkDocs Drive client after users log in. The MSI installer for Amazon WorkDocs Drive supports the following optional installation parameters: • SITEID – Pre-populates the Amazon WorkDocs site information for users during registration. For example, SITEID=site-name. • DefaultDriveLetter – Pre-populates the drive letter to be used for mounting Amazon WorkDocs Drive. For example, DefaultDriveLetter=W. Remember, each user must have a diﬀerent drive letter. Also, users can change the drive name, but not the drive letter, after they start Amazon WorkDocs Drive for the ﬁrst time. The following example deploys Amazon WorkDocs Drive with no user interfaces and no restarts. Note that it uses the MSI ﬁle's default name: msiexec /i "AWSWorkDocsDriveClient.msi" SITEID=your_workdocs_site_ID DefaultDriveLetter=your_drive_letter REBOOT=REALLYSUPPRESS /norestart /qn 60 Amazon WorkDocs Administration Guide Inviting and managing Amazon WorkDocs users By default, when you attach a directory during site creation, the Auto activation feature in Amazon WorkDocs adds all the users in that directory to the new site as managed users. In WorkDocs, managed users don't need to log in with separate credentials. They can share and collaborate on ﬁles, and they automatically have 1 TB of storage. However, you can turn Auto activation oﬀ when you only want to add some of the users in a directory, and steps in the next sections explain how to do that. In addition, you can invite, enable, or disable users, and change user roles and settings. You can also promote a user to an administrator. For more information about promoting users, see Promoting a user to administrator. You do those tasks in the admin control panel in the Amazon WorkDocs web client, and the steps in the following sections explain how. But, if you're new to Amazon WorkDocs, take a few minutes and learn about the various user roles before you dive into administrative tasks. Contents • User roles overview • Starting the admin control panel • Turning oﬀ Auto activation • Managing link sharing • Controlling user invitations with Auto activation enabled • Inviting new users • Editing users • Disabling users • Transferring document ownership • Downloading user lists User roles overview Amazon WorkDocs deﬁnes the following user roles. You can change users' roles by editing their user proﬁles. For more information, see Editing users. User roles 61 Amazon WorkDocs Administration Guide • Admin: A paid user who has administrative permissions for the entire site, including user management and site setting conﬁguration. For more information about how to promote a user to an administrator, see Promoting a user to administrator. • Power user: A paid user who has a special set of permissions from the administrator. For more information about how to set permissions for a power user, see Security – Simple ActiveDirectory sites and Security – ActiveDirectory connector sites. • User: A paid user who can save ﬁles and collaborate with others in an Amazon WorkDocs site. • Guest user: An unpaid user who can only view ﬁles. You can upgrade Guest users to the User, Power user, or Administrator roles. Note When you change a guest user's role, you perform a one-time action that you cannot reverse. Amazon WorkDocs also deﬁnes these additional user types. WS user A user with an assigned WorkSpaces WorkSpace. • Access to all Amazon WorkDocs features • Default storage of 50 GB (can pay to upgrade to 1 TB) • No monthly charges Upgraded WS user A user with an assigned WorkSpaces WorkSpace and upgraded storage. • Access to all Amazon WorkDocs features • Default storage of 1 TB (additional storage available on a pay-as-you-go basis) • Monthly charges apply Amazon WorkDocs user An active Amazon WorkDocs user without an assigned WorkSpaces WorkSpace. User roles 62 Amazon WorkDocs Administration Guide • Access to all Amazon WorkDocs features • Default storage of 1 TB (additional storage available on a pay-as-you-go basis) • Monthly charges apply Starting the admin control panel You use the administrative control panel in the Amazon WorkDocs web client to turn Auto activation oﬀ and on, and change user roles and settings. To
workdocs-ag-023	workdocs-ag.pdf	23	storage. • Access to all Amazon WorkDocs features • Default storage of 1 TB (additional storage available on a pay-as-you-go basis) • Monthly charges apply Amazon WorkDocs user An active Amazon WorkDocs user without an assigned WorkSpaces WorkSpace. User roles 62 Amazon WorkDocs Administration Guide • Access to all Amazon WorkDocs features • Default storage of 1 TB (additional storage available on a pay-as-you-go basis) • Monthly charges apply Starting the admin control panel You use the administrative control panel in the Amazon WorkDocs web client to turn Auto activation oﬀ and on, and change user roles and settings. To open the admin control panel 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. Note Some control panel options diﬀer between cloud directories and connected directories. Turning oﬀ Auto activation You turn oﬀ Auto activation when you don't want to add all the users in a directory to a new site, and when you want to set diﬀerent permissions and roles for the users that you invite to a new site. When you turn Auto activation oﬀ, you can also decide who has the ability to invite new users to the site — current users, power users, or administrators. These steps explain how to do both tasks. To turn oﬀ Auto activation 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. Starting the admin control panel 63 Amazon WorkDocs Administration Guide 2. Under Admin, choose Open admin control panel. 3. Scroll down to Security and choose Change. The Policy Settings dialog box appears. 4. Under Auto activation, clear the check box next to Allow all users in your directory to be automatically activated upon their ﬁrst login to your WorkDocs site. The options change under Who should be allowed to activate directory users in your WorkDocs site. You can let current users invite new users, or you can give that ability to power users or other administrators. 5. Select an option, then choose Save Changes. Repeat steps 1-4 to re-enable Auto activation. Managing link sharing This topic explains how to manage link sharing. Amazon WorkDocs users can share their ﬁles and folders by sharing links to them. They can share ﬁle links inside and outside your organization, but they can only share folder links internally. As an administrator, you manage who can share links. To enable link sharing 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. 3. Scroll down to Security and choose Change. The Policy Settings dialog box appears. 4. Under Choose your setting for shareable links, select an option: • Do not allow site-wide or public shareable links – Disables link sharing for all users. • Allow users to create site-wide shareable links, but do not allow them to create public shareable links – Limits link sharing to just site members. Managed users can create this type of link. Managing link sharing 64 Amazon WorkDocs Administration Guide • Allow users to create site-wide shareable links, but only power users can create public shareable links – Managed users can create site-wide links, but only power users can create public links. Public links allow access to anyone on the internet. • All managed users can create site-wide & public shareable links – Managed users can create public links. 5. Choose Save Changes. Controlling user invitations with Auto activation enabled When you enable Auto activation—and remember, it's on by default—you can give users the ability to invite other users. You can grant permission to one of the following: • All users • Power users • Administrators. You can also disable permissions entirely, and these steps explain how. To set invitation permissions 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. 3. Scroll down to Security and choose Change. The Policy Settings dialog box appears. 4. Under Who should be allowed to activate directory users in your WorkDocs site, select the Share with external users check box, select one of the options below the check box, then choose Save Changes. —OR— Clear the check box if you don't want anyone to invite new users, then choose Save Changes. Controlling user invitations with Auto activation enabled 65 Amazon WorkDocs Inviting new users Administration Guide You can invite new users to join a directory. You can also enable existing users to invite new users. For more information, see Security – Simple ActiveDirectory sites and Security – ActiveDirectory connector sites in this guide. To invite new users 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. 3. Under Manage Users, choose Invite
workdocs-ag-024	workdocs-ag.pdf	24	Clear the check box if you don't want anyone to invite new users, then choose Save Changes. Controlling user invitations with Auto activation enabled 65 Amazon WorkDocs Inviting new users Administration Guide You can invite new users to join a directory. You can also enable existing users to invite new users. For more information, see Security – Simple ActiveDirectory sites and Security – ActiveDirectory connector sites in this guide. To invite new users 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. 3. Under Manage Users, choose Invite Users. 4. In the Invite Users dialog box, for Who would you like to invite?, enter the invitee's email address, and choose Send. Repeat this step for each invitation. Amazon WorkDocs sends an invitation email to each recipient. The mail contains a link and instructions about how to create an Amazon WorkDocs account. The invitation link expires after 30 days. Editing users You can change user information and settings. To edit users 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. 3. Under Manage Users, choose the pencil icon ( next to the user's name. 4. In the Edit User dialog box, you can edit the following options: Inviting new users ) 66 Amazon WorkDocs Administration Guide First Name (Cloud Directory only) The user's ﬁrst name. Last Name (Cloud Directory only) The user's last name. Status Speciﬁes whether the user is Active or Inactive. For more information, see Disabling users. Role Speciﬁes whether someone is a user or administrator. You can also upgrade or downgrade users that have an WorkSpaces WorkSpace assigned to them. For more information, see User roles overview. Storage Speciﬁes the storage limit for an existing user. 5. Choose Save Changes. Disabling users You disable a user's access by changing their status to Inactive. To change user status to Inactive 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. 3. Under Manage Users, choose the pencil icon ( next to the user's name. 4. Choose Inactive, and choose Save Changes The inactivated user can't access your Amazon WorkDocs site. Disabling users ) 67 Amazon WorkDocs Note Administration Guide Changing a user to Inactive status does not delete their ﬁles, folders, or feedback from your Amazon WorkDocs site. However, you can transfer an inactive user's ﬁles and folders to an active user. For more information, see Transferring document ownership. Deleting pending users You can delete Simple AD, AWS Managed Microsoft, and AD Connector users in Pending status. To delete one of those users, choose the trash can icon ( next to the user's name. ) Your Amazon WorkDocs site must always have at least one active user who is not a guest user. If you need to delete all users, delete the entire site. We do not recommend that you delete registered users. Instead, you should switch a user from Active to Inactive status to prevent them from accessing your Amazon WorkDocs site. Transferring document ownership You can transfer an inactive user's ﬁles and folders to an active user. For more information on how to deactivate a user, see Disabling users. Warning You can't undo this action. To transfer document ownership 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. Deleting pending users 68 Amazon WorkDocs Administration Guide 3. Under Manage Users, search for the inactive user. 4. Choose the pencil icon ( next to the inactive user's name. 5. Select Transfer Document Ownership and enter the new owner's email address. ) 6. Choose Save Changes. Downloading user lists To download a list of users from the Admin control panel, you must install Amazon WorkDocs Companion. To install Amazon WorkDocs Companion, see Apps & Integrations for Amazon WorkDocs. To download a list of users 1. Choose the proﬁle icon in the upper-right corner of the WorkDocs client. 2. Under Admin, choose Open admin control panel. 3. Under Manage Users, choose Download user. 4. For Download user, choose one of the following options to export a list of users as a .json ﬁle to your desktop: • All users • Guest user • WS user • User • Power user • Admin 5. WorkDocs saves the ﬁle to one of the following locations: • Windows – Downloads/WorkDocsDownloads • macOS – hard drive/users/username/WorkDocsDownloads/folder Downloading user lists 69 Amazon WorkDocs Administration Guide Note Downloads may take some time. Also, downloaded ﬁles do not land in your /~users folder. For more information about these user roles, see User roles overview. Downloading user lists 70 Amazon WorkDocs Administration Guide Sharing and collaboration Your users can share content
workdocs-ag-025	workdocs-ag.pdf	25	to export a list of users as a .json ﬁle to your desktop: • All users • Guest user • WS user • User • Power user • Admin 5. WorkDocs saves the ﬁle to one of the following locations: • Windows – Downloads/WorkDocsDownloads • macOS – hard drive/users/username/WorkDocsDownloads/folder Downloading user lists 69 Amazon WorkDocs Administration Guide Note Downloads may take some time. Also, downloaded ﬁles do not land in your /~users folder. For more information about these user roles, see User roles overview. Downloading user lists 70 Amazon WorkDocs Administration Guide Sharing and collaboration Your users can share content by sending a link or an invite. Users can also collaborate with external users if you enable external sharing. Amazon WorkDocs controls access to folders and ﬁles through the use of permissions. The system applies permissions based on a user's role. Contents • Sharing links • Sharing by invite • External sharing • Permissions • Enabling collaborative editing Sharing links Users can choose Share a link to quickly copy and share hyperlinks for Amazon WorkDocs content with coworkers and external users both inside and outside their organization. When users share a link, they can conﬁgure it to allow one of the following access options: • All members of the Amazon WorkDocs site can search for, view, and comment on the ﬁle. • Anyone with the link, even people who are not members of the Amazon WorkDocs site, can view the ﬁle. This link option restricts permissions to viewing only. Recipients with viewing permissions can only view a ﬁle. Commenting permissions enable users to comment and perform update or delete operations, such as uploading a new ﬁle or deleting an existing ﬁle. By default, all managed users can create public links. To change this setting, update your Security settings from your admin control panel. For more information, see Managing Amazon WorkDocs from the site admin control panel. Sharing links 71 Amazon WorkDocs Sharing by invite Administration Guide When you enable sharing by invite, your site users can share ﬁles or folders with individual users, and with groups, by sending invitation emails. The invitations contain links to the shared content, and invitees can open the shared ﬁles or folders. Invitees can also share those ﬁles or folders with other site members, and with external users. You can set permission levels for each invited user. You can also create team folders to share by invite with directory groups that you create. Note Sharing invitations do not include members of nested groups. To include those members, you must add them to the Share by Invite list. For more information, see Managing Amazon WorkDocs from the site admin control panel. External sharing External sharing allows managed users of an Amazon WorkDocs site to share ﬁles and folders, and collaborate with external users without incurring extra costs. Site users can share ﬁles and folders with external users without requiring recipients to be paid users of the Amazon WorkDocs site. When you enable external sharing, users can enter the email address of the external user they want to share with and set appropriate viewer sharing permissions. When external users are added, permissions are limited to viewer-only, and other permissions are not available. External users receive an email notiﬁcation with a link to the shared ﬁle or folder. Choosing the link takes external users to the site, where they enter their credentials to log in to Amazon WorkDocs. They can see the shared ﬁle or folder in the Shared with me view. File owners can modify sharing permissions or remove access for the external user from a ﬁle or folder at any time. External sharing for the site must be enabled by the site administrator in order for managed users to share content with external users. For Guest users to become contributors or co-owners, they must be upgraded to the User level by a site administrator. For more information, see User roles overview. By default, external sharing is turned on and all users can invite external users. To change this setting, update your Security settings from your admin control panel. For more information, see Managing Amazon WorkDocs from the site admin control panel. Sharing by invite 72 Amazon WorkDocs Permissions Administration Guide Amazon WorkDocs uses permissions to control access to folders and ﬁles. Permissions are applied based on user roles. Contents • User roles • Permissions for shared folders • Permissions for ﬁles in shared folders • Permissions for ﬁles not in shared folders User roles User roles control folder and ﬁle permissions. You can apply the following user roles at the folder level: • Folder owner – The owner of a folder or ﬁle. • Folder co-owner – A user or group that the owner designates as the co-owner of a folder or ﬁle. • Folder contributor
workdocs-ag-026	workdocs-ag.pdf	26	WorkDocs Permissions Administration Guide Amazon WorkDocs uses permissions to control access to folders and ﬁles. Permissions are applied based on user roles. Contents • User roles • Permissions for shared folders • Permissions for ﬁles in shared folders • Permissions for ﬁles not in shared folders User roles User roles control folder and ﬁle permissions. You can apply the following user roles at the folder level: • Folder owner – The owner of a folder or ﬁle. • Folder co-owner – A user or group that the owner designates as the co-owner of a folder or ﬁle. • Folder contributor – Someone with unlimited access to a folder. • Folder viewer – Someone with limited access (read-only permissions) to a folder. You can apply the following user roles at the individual ﬁle level: • Owner – The owner of a ﬁle. • Co-owner – A user or group that the owner designates as the co-owner of the ﬁle. • Contributor* – Someone allowed to give feedback on ﬁle. • Viewer – Someone with limited access (read-only and view activity permissions) to the ﬁle. • Anonymous viewer – A non-registered user outside of the organization who can view a ﬁle that has been shared using an external viewing link. Unless otherwise indicated, an anonymous viewer has the same read-only permissions as a viewer. Anonymous viewers cannot view ﬁle activity. * Contributors can't rename existing ﬁle versions. However, they can upload a new version of a ﬁle with a diﬀerent name. Permissions 73 Amazon WorkDocs Administration Guide Permissions for shared folders The following permissions apply to user roles for shared folders: Note Permissions applied for a folder also apply to the sub-folders and ﬁles in that folder. • View – View the contents of a shared folder. • View sub-folders – View a sub-folder. • View shares – View the other users a folder is shared with. • Download folder – Download a folder. • Add sub-folder – Add a sub-folder. • Share – Share the top-level folder with other users. • Revoke share – Revoke the sharing of the top-level folder. • Delete sub-folder – Delete a sub-folder. • Delete top-level folder – Delete the top-level shared folder. View View sub- folde View shares Download folder Add sub- Share Revoke share folder rs ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Folder owner Folder co- owner Folder contribut or Delete sub- folder Delete top- level folder ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Permissions for shared folders 74 Amazon WorkDocs View Folder viewer ✓ View sub- folde rs ✓ View shares Download folder Add sub- Share Revoke share folder ✓ ✓ Administration Guide Delete sub- folder Delete top- level folder Permissions for ﬁles in shared folders The following permissions apply to user roles for ﬁles in a shared folder: • Annotate – Add feedback to a ﬁle. • Delete – Delete a ﬁle in a shared folder. • Rename – Rename ﬁles. • Upload – Upload new versions of a ﬁle. • Download – Download a ﬁle. This is the default permission. You can use ﬁle properties to allow or deny the ability to download shared ﬁles. • Prevent download – Prevent a ﬁle from being downloaded. Note • When you select this option, users with View permissions can still download ﬁles. To prevent that, open the shared folder and clear the Allow Downloads setting for each of the ﬁles that you don't want those users to download. • When the owner or co-owner of an MP4 ﬁle disallows downloads for that ﬁle, contributors and viewers cannot play it in the Amazon WorkDocs web client. • Share – Share a ﬁle with other users. • Revoke sharing – Revoke the sharing of a ﬁle. • View – View a ﬁle in a shared folder. • View shares – View the other users that a ﬁle is shared with. • View annotations – View feedback from other users. • View activity – View the activity history of a ﬁle. Permissions for ﬁles in shared folders 75 Amazon WorkDocs Administration Guide • View versions – View previous versions of a ﬁle. • Delete versions – Delete one or more versions of a ﬁle. • Recover versions – Recover one or more deleted versions of a ﬁle. • View all private comments – Owner/co-owner can see all private comments for a document, even if they are not replies to their comment. AnnotateDeleteRenameUploadDownloadPrevent download ShareRevoke View View shares View annotatio View activity View versions Delete versions Recover versions View all share ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ * ✓ ns private comments* ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓
workdocs-ag-027	workdocs-ag.pdf	27	Delete one or more versions of a ﬁle. • Recover versions – Recover one or more deleted versions of a ﬁle. • View all private comments – Owner/co-owner can see all private comments for a document, even if they are not replies to their comment. AnnotateDeleteRenameUploadDownloadPrevent download ShareRevoke View View shares View annotatio View activity View versions Delete versions Recover versions View all share ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ * ✓ ns private comments* ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ File ✓ owner* Folder ✓ owner* Folder ✓ co- owner* * Folder ✓ contribut or*** Folder viewer Anonymous viewer ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ * In this case, the ﬁle owner is the person who uploaded the original version of a ﬁle to a shared folder. The permissions for this role apply only to the owned ﬁle, not to all the ﬁles in the shared folder. Permissions for ﬁles in shared folders 76 Amazon WorkDocs Administration Guide Owners and co-owners can see all private comments. Contributors can only see private comments that are replies to their comments. * Contributors can't rename existing ﬁle versions. However, they can upload a new version of a ﬁle with a diﬀerent name. Permissions for ﬁles not in shared folders The following permissions apply to user roles for ﬁles that do not reside in a shared folder: • Annotate – Add feedback to a ﬁle. • Delete – Delete a ﬁle. • Rename – Rename ﬁles. • Upload – Upload new versions of a ﬁle. • Download – Download a ﬁle. This is the default permission. You can use ﬁle properties to allow or deny the ability to download shared ﬁles. • Prevent download – Prevent a ﬁle from being downloaded. Note When the owner or co-owner of an MP4 ﬁle disallows downloads for that ﬁle, contributors and viewers cannot play it in the Amazon WorkDocs web client. • Share – Share a ﬁle with other users. • Revoke share – Revoke the sharing of a ﬁle. • View – View a ﬁle. • View shares – View the other users that a ﬁle is shared with. • View annotations – View feedback from other users. • View activity – View the activity history of a ﬁle. • View versions – View previous versions of a ﬁle. • Delete versions – Delete one or more versions of a ﬁle. • Recover versions – Recover one or more deleted versions of a ﬁle. Permissions for ﬁles not in shared folders 77 Amazon WorkDocs Administration Guide AnnotateDeleteRenameUploadDownloadPrevent download ShareRevoke View View shares View annotatio View activity View versions Delete versions Recover versions share ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ns ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ ✓ Owner✓ ✓ Co- owner ✓ Contribut or** Viewer Anonymous viewer * File owners and co-owners can see all private comments. Contributors can only see private comments that are replies to their comments. ** Contributors can't rename existing ﬁle versions. However, they can upload a new version of a ﬁle with a diﬀerent name. Enabling collaborative editing You use the Online Editing Settings section in your Admin control panel to enable the collaborative editing options. Contents • Enabling Hancom ThinkFree • Enabling Open with Oﬃce Online Enabling Hancom ThinkFree You can enable Hancom ThinkFree for your Amazon WorkDocs site, so that users can create and collaboratively edit Microsoft Oﬃce ﬁles from the Amazon WorkDocs web application. For more information, see Editing with Hancom ThinkFree. Enabling collaborative editing 78 Amazon WorkDocs Administration Guide Hancom ThinkFree is available at no additional cost for Amazon WorkDocs users. No additional licensing or software installation is needed. To enable Hancom ThinkFree Enable Hancom ThinkFree editing from the Admin control panel. 1. Under My account, choose Open admin control panel. 2. 3. For Hancom Online Editing, choose Change. Select Enable Hancom Online Editing Feature, review the terms of usage, and then choose Save. To disable Hancom ThinkFree Disable Hancom ThinkFree editing from the Admin control panel. 1. Under My account, choose Open admin control panel. 2. For Hancom Online Editing, choose Change. 3. Clear the Enable Hancom Online Editing Feature check box, then choose Save. Enabling Open with Oﬃce Online Enable Open with Oﬃce Online for your Amazon WorkDocs site, so that users can collaboratively edit Microsoft Oﬃce ﬁles from the Amazon WorkDocs web application. Open with Oﬃce Online is available at no additional cost for Amazon
workdocs-ag-028	workdocs-ag.pdf	28	Change. Select Enable Hancom Online Editing Feature, review the terms of usage, and then choose Save. To disable Hancom ThinkFree Disable Hancom ThinkFree editing from the Admin control panel. 1. Under My account, choose Open admin control panel. 2. For Hancom Online Editing, choose Change. 3. Clear the Enable Hancom Online Editing Feature check box, then choose Save. Enabling Open with Oﬃce Online Enable Open with Oﬃce Online for your Amazon WorkDocs site, so that users can collaboratively edit Microsoft Oﬃce ﬁles from the Amazon WorkDocs web application. Open with Oﬃce Online is available at no additional cost for Amazon WorkDocs users who also have a Microsoft Oﬃce 365 Work or School account with a license to edit in Oﬃce Online. For more information, see Open with Oﬃce Online. To enable Open with Oﬃce Online Enable Open with Oﬃce Online from the Admin control panel. 1. Under My account, choose Open admin control panel. 2. 3. For Oﬃce Online, choose Change. Select Enable Oﬃce Online, then choose Save. Enabling Open with Oﬃce Online 79 Amazon WorkDocs Administration Guide To disable Open with Oﬃce Online Disable Open with Oﬃce Online from the Admin control panel. 1. Under My account, choose Open admin control panel. 2. For Oﬃce Online, choose Change. 3. Clear the Enable Oﬃce Online check box, then choose Save. Enabling Open with Oﬃce Online 80 Amazon WorkDocs Administration Guide Migrating ﬁles to Amazon WorkDocs Amazon WorkDocs administrators can use the Amazon WorkDocs Migration Service to perform a large-scale migration of multiple ﬁles and folders to their Amazon WorkDocs site. The Amazon WorkDocs Migration Service works with Amazon Simple Storage Service (Amazon S3). This lets you migrate departmental ﬁle shares and home drive or user ﬁle shares to Amazon WorkDocs. During this process, Amazon WorkDocs provides an AWS Identity and Access Management (IAM) policy for you. Use this policy to create a new IAM role that grants access to the Amazon WorkDocs Migration Service to do the following: • Read and list the Amazon S3 bucket that you designate. • Read and write to the Amazon WorkDocs site that you designate. Complete the following tasks to migrate your ﬁles and folders to Amazon WorkDocs. Before you begin, conﬁrm that you have the following permissions: • Administrator permissions for your Amazon WorkDocs site • Permissions to create an IAM role If your Amazon WorkDocs site is set up on the same directory as your WorkSpaces ﬂeet, you must follow these requirements: • Do not use Admin for your Amazon WorkDocs account user name. Admin is a reserved user role in Amazon WorkDocs. • Your Amazon WorkDocs administrator user type must be Upgraded WS User. For more information, see User roles overview and Editing users. Note Directory structure, ﬁle names, and ﬁle content are preserved when migrating to Amazon WorkDocs. File ownership and permissions are not preserved. Tasks 81 Amazon WorkDocs Administration Guide • Step 1: Preparing content for migration • Step 2: Uploading ﬁles to Amazon S3 • Step 3: Scheduling a migration • Step 4: Tracking a migration • Step 5: Cleaning up resources Step 1: Preparing content for migration To prepare your content for migration 1. On your Amazon WorkDocs site, under My Documents, create a folder that you want to migrate your ﬁles and folders to. 2. Conﬁrm the following: • The source folder contains no more than 100,000 ﬁles and subfolders. Migrations fail if you exceed that limit. • No individual ﬁles exceed 5 TB. • Each ﬁle name contains 255 characters or less. Amazon WorkDocs Drive only displays ﬁles with a full directory path of 260 characters or less. Warning Attempting to migrate ﬁles or folders with names containing the following characters can cause errors and stop the migration process. If this occurs, choose Download report to download a log listing the errors, the ﬁles that failed to migrate, and any successfully migrated ﬁles. • Trailing spaces – For example: an extra space at the end of a ﬁle name. • Periods at the beginning or end – For example: .file, .file.ppt, ., .., or file. • Tildes at the beginning or end – For example: file.doc~, ~file.doc, or ~$file.doc • File names ending in .tmp – For example: file.tmp • File names exactly matching these case-sensitive terms – Microsoft User Data, Outlook files, Thumbs.db, or Thumbnails Step 1: Preparing content for migration 82 Amazon WorkDocs Administration Guide • File names containing any of these characters – * (asterisk), / (forward slash), \ (back slash), : (colon), < (less than), > (greater than), ? (question mark), \| (vertical bar/pipe), " (double quotes), or \202E (character code 202E). Step 2: Uploading ﬁles to Amazon S3 To upload ﬁles to Amazon S3 1. Create a new Amazon Simple Storage Service (Amazon S3) bucket in your AWS account that
workdocs-ag-029	workdocs-ag.pdf	29	– For example: file.tmp • File names exactly matching these case-sensitive terms – Microsoft User Data, Outlook files, Thumbs.db, or Thumbnails Step 1: Preparing content for migration 82 Amazon WorkDocs Administration Guide • File names containing any of these characters – * (asterisk), / (forward slash), \ (back slash), : (colon), < (less than), > (greater than), ? (question mark), \| (vertical bar/pipe), " (double quotes), or \202E (character code 202E). Step 2: Uploading ﬁles to Amazon S3 To upload ﬁles to Amazon S3 1. Create a new Amazon Simple Storage Service (Amazon S3) bucket in your AWS account that you want to upload your ﬁles and folders to. The Amazon S3 bucket must be in the same AWS account and AWS Region as your Amazon WorkDocs site. For more information, see Getting started with Amazon Simple Storage Service in the Amazon Simple Storage Service User Guide. 2. Upload your ﬁles to the Amazon S3 bucket that you created in the previous step. We recommend using AWS DataSync to upload your ﬁles and folders to the Amazon S3 bucket. DataSync provides additional tracking, reporting, and syncing features. For more information, see How AWS DataSync works and Using identity-based policies (IAM policies) for DataSync in the AWS DataSync User Guide. Step 3: Scheduling a migration After you complete steps 1 and 2, use the Amazon WorkDocs Migration Service to schedule the migration. The Migration Service can take up to a week to process your migration request and send you an email saying that you can begin your migration. If you start the migration before you receive the email, the management console displays a message telling you to wait. When you schedule the migration, your Amazon WorkDocs user account Storage setting automatically changes to Unlimited. Note Migrating ﬁles that exceed your Amazon WorkDocs storage limit can result in additional costs. For more information, see Amazon WorkDocs Pricing. The Amazon WorkDocs Migration Service provides an AWS Identity and Access Management (IAM) policy for you to use for the migration. With this policy, you create a new IAM role that grants the Amazon WorkDocs Migration Service access to the Amazon S3 bucket and Amazon WorkDocs site Step 2: Uploading ﬁles to Amazon S3 83 Amazon WorkDocs Administration Guide that you designate. You also subscribe to Amazon SNS email notiﬁcations to receive updates when your migration request is scheduled, and when it begins and ends. To schedule a migration 1. From the Amazon WorkDocs console, choose Apps, Migrations. • If this is your ﬁrst time accessing Amazon WorkDocs Migration Service, you are prompted to subscribe to Amazon SNS email notiﬁcations. Subscribe, conﬁrm in the email message that you receive, then choose Continue. 2. Choose Create Migration. 3. For Source Type, choose Amazon S3. 4. Choose Next. 5. For Data Source & Validation, under Sample Policy, copy the supplied IAM policy. 6. Use the IAM policy that you copied in the previous step to create a new IAM policy and role, as follows: a. Open the IAM console at https://console.aws.amazon.com/iam/. b. Choose Policies, Create policy. c. Choose JSON and paste in the IAM policy that you copied to your clipboard earlier. d. Choose Review policy. Enter a policy name and description. e. f. g. Choose Create policy. Choose Roles, Create role. Select Another AWS account. For Account ID, enter one of the following: • For the US East (N. Virginia) Region, enter 899282061130 • For the US West (Oregon) Region, enter 814301586344 • For the Asia Paciﬁc (Singapore) Region, enter 900469912330 • For the Asia Paciﬁc (Sydney) Region, enter 031131923584 • For the Asia Paciﬁc (Tokyo) Region, enter 178752524102 • For the Europe (Ireland) Region, enter 191921258524 h. Select the new policy that you created and choose Next: Review. If you don't see the new policy, choose the refresh icon. i. Enter a role name and description. Choose Create role. Step 3: Scheduling a migration 84 Amazon WorkDocs Administration Guide j. On the Roles page, under Role name, choose the role name that you created. k. On the Summary page, change the Maximum CLI/API session duration to 12 hours. l. Copy the Role ARN to your clipboard to use in the next step. 7. Return to the Amazon WorkDocs Migration Service. For Data Source & Validation, under Role ARN, paste the role ARN from the IAM role that you copied in the previous step. 8. For Bucket, select the Amazon S3 bucket to migrate the ﬁles from. 9. Choose Next. 10. For Select a destination WorkDocs Folder, select the destination folder in Amazon WorkDocs to migrate the ﬁles to. 11. Choose Next. 12. Under Review, for Title, enter a name for the migration. 13. Select the date and time for the migration. 14. Choose Send. Step 4: Tracking a migration You can track your migration from
workdocs-ag-030	workdocs-ag.pdf	30	the Amazon WorkDocs Migration Service. For Data Source & Validation, under Role ARN, paste the role ARN from the IAM role that you copied in the previous step. 8. For Bucket, select the Amazon S3 bucket to migrate the ﬁles from. 9. Choose Next. 10. For Select a destination WorkDocs Folder, select the destination folder in Amazon WorkDocs to migrate the ﬁles to. 11. Choose Next. 12. Under Review, for Title, enter a name for the migration. 13. Select the date and time for the migration. 14. Choose Send. Step 4: Tracking a migration You can track your migration from within the Amazon WorkDocs Migration Service landing page. To access the landing page from the Amazon WorkDocs site, choose Apps, Migrations. Choose your migration to view its details and track its progress. You can also choose Cancel Migration if you need to cancel it, or choose Update to update the timeline for the migration. After a migration is complete, you can choose Download report to download a log of the successfully migrated ﬁles, any failures, or errors. The following migration states provide the status of your migration: Scheduled The migration is scheduled but not started. You can cancel migrations or update migration start times up to ﬁve minutes before the scheduled start time. Migrating The migration is in progress. Success The migration is complete. Step 4: Tracking a migration 85 Amazon WorkDocs Partial Success Administration Guide The migration is partially complete. For more details, view the migration summary and download the provided report. Failed The migration failed. For more details, view the migration summary and download the provided report. Canceled The migration is canceled. Step 5: Cleaning up resources When your migration is complete, delete the migration policy and role that you created from the IAM console. To delete the IAM policy and role 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. Choose Policies. 3. 4. Search for and select the policy that you created. For Policy actions, choose Delete. 5. Choose Delete. 6. Choose Roles. 7. Search for and select the role that you created. 8. Choose Delete role, Delete. When a scheduled migration starts, your Amazon WorkDocs user account Storage setting is automatically changed to Unlimited. After the migration, you can use the admin control panel to change that setting. For more information, see Editing users. Step 5: Cleaning up resources 86 Amazon WorkDocs Administration Guide Troubleshooting Amazon WorkDocs Issues The following information can help you troubleshoot issues with Amazon WorkDocs. Issues • Can't set up my Amazon WorkDocs site in a speciﬁc AWS Region • Want to set up my Amazon WorkDocs site in an existing Amazon VPC • User needs to reset their password • User accidentally shared a sensitive document • User left the organization and didn't transfer document ownership • Need to deploy Amazon WorkDocs Drive or Amazon WorkDocs Companion to multiple users • Online editing isn't working Can't set up my Amazon WorkDocs site in a speciﬁc AWS Region If you're setting up a new Amazon WorkDocs site, select the AWS Region during setup. For more information, see the tutorial for your particular use case under Getting started with Amazon WorkDocs. Want to set up my Amazon WorkDocs site in an existing Amazon VPC When setting up your new Amazon WorkDocs site, create a directory using the existing virtual private cloud (VPC). Amazon WorkDocs uses this directory to authenticate users. User needs to reset their password Users can reset their passwords by choosing Forgot password? on their sign-in screens. User accidentally shared a sensitive document To revoke access to the document, choose Share by invite next to the document, then remove the users who should no longer have access. If the document was shared using a link, choose Share a link and disable the link. Can't set up my Amazon WorkDocs site in a speciﬁc AWS Region 87 Amazon WorkDocs Administration Guide User left the organization and didn't transfer document ownership Transfer document ownership to another user in the admin control panel. For more information, see Transferring document ownership. Need to deploy Amazon WorkDocs Drive or Amazon WorkDocs Companion to multiple users Deploy to multiple users in an enterprise by using group policy. For more information, see Identity and access management for Amazon WorkDocs. For speciﬁc information about deploying Amazon WorkDocs Drive to multiple users, see Deploying Amazon WorkDocs Drive to multiple computers. Online editing isn't working Verify that you have Amazon WorkDocs Companion installed. To install Amazon WorkDocs Companion, see Apps & Integrations for Amazon WorkDocs. User left the organization and didn't transfer document ownership 88 Amazon WorkDocs Administration Guide Managing Amazon WorkDocs for Amazon Business If you are an administrator for Amazon WorkDocs for Amazon Business, you can manage users by signing in to https://workdocs.aws/ using your Amazon Business credentials. To
workdocs-ag-031	workdocs-ag.pdf	31	For more information, see Identity and access management for Amazon WorkDocs. For speciﬁc information about deploying Amazon WorkDocs Drive to multiple users, see Deploying Amazon WorkDocs Drive to multiple computers. Online editing isn't working Verify that you have Amazon WorkDocs Companion installed. To install Amazon WorkDocs Companion, see Apps & Integrations for Amazon WorkDocs. User left the organization and didn't transfer document ownership 88 Amazon WorkDocs Administration Guide Managing Amazon WorkDocs for Amazon Business If you are an administrator for Amazon WorkDocs for Amazon Business, you can manage users by signing in to https://workdocs.aws/ using your Amazon Business credentials. To invite a new user to Amazon WorkDocs for Amazon Business 1. Sign in with your Amazon Business credentials at https://workdocs.aws/. 2. On the Amazon WorkDocs for Amazon Business home page, open the navigation pane on the left. 3. Choose Admin Settings. 4. Choose Add people. 5. 6. For Recipients, enter the email addresses or user names of the users to invite. (Optional) Customize the invitation message. 7. Choose Done. To search for a user on Amazon WorkDocs for Amazon Business 1. Sign in with your Amazon Business credentials at https://workdocs.aws/. 2. On the Amazon WorkDocs for Amazon Business home page, open the navigation pane on the left. 3. Choose Admin Settings. 4. For Search users, enter the ﬁrst name of the user, and press Enter. To select user roles on Amazon WorkDocs for Amazon Business 1. Sign in with your Amazon Business credentials at https://workdocs.aws/. 2. On the Amazon WorkDocs for Amazon Business home page, open the navigation pane on the left. 3. Choose Admin Settings. 4. Under People, next to the user, select the Role to assign to the user. 89 Amazon WorkDocs Administration Guide To delete a user on Amazon WorkDocs for Amazon Business 1. Sign in with your Amazon Business credentials at https://workdocs.aws/. 2. On the Amazon WorkDocs for Amazon Business home page, open the navigation pane on the left. 3. Choose Admin Settings. 4. Under People, choose the ellipsis (...) next to the user. 5. Choose Delete. 6. If prompted, enter a new user to transfer the user's ﬁles to, and choose Delete. 90 Amazon WorkDocs Administration Guide IP address and domains to add to your allow list If you implement IP ﬁltering on devices that access Amazon WorkDocs, add the following IP addresses and domains to your allow list. Doing so enables Amazon WorkDocs and Amazon WorkDocs Drive to connect to the WorkDocs service. • zocalo.ap-northeast-1.amazonaws.com • zocalo.ap-southeast-2.amazonaws.com • zocalo.eu-west-1.amazonaws.com • zocalo.eu-central-1.amazonaws.com • zocalo.us-east-1.amazonaws.com • zocalo.us-gov-west-1.amazonaws.com • zocalo.us-west-2.amazonaws.com • awsapps.com • amazonaws.com • cloudfront.net • aws.amazon.com • amazonworkdocs.com • console.aws.amazon.com • cognito-identity.us-east-1.amazonaws.com • ﬁrehose.us-east-1.amazonaws.com If you want to use IP address ranges, see AWS IP address ranges in the AWS general reference. 91 Amazon WorkDocs Administration Guide Document history The following table describes important changes to the Amazon WorkDocs Administration Guide, beginning in February 2018. For notiﬁcations about updates to this documentation, you can subscribe to an RSS feed. Change Description Date New ﬁle owner permissions July 29, 2022 Administrators can now provide the Delete Version and Recover Version permissio ns. The permissions are part of the release of the DeleteDocumentVersion API. Amazon WorkDocs Backup Removed the Amazon WorkDocs Backup documenta June 24, 2021 tion from the Amazon WorkDocs Administr ation Guide because the component is no longer supported. Managing Amazon WorkDocs for Amazon Business Amazon WorkDocs for Amazon Business supports March 26, 2020 user management by administrators. For more information, see Managing Amazon WorkDocs for Amazon Business in the Amazon WorkDocs Administr ation Guide. Amazon WorkDocs administr ators can use the Amazon WorkDocs Migration Service to perform a large-scale Migrating ﬁles to Amazon WorkDocs August 8, 2019 92 Amazon WorkDocs Administration Guide IP allow list settings Hancom ThinkFree Open with Oﬃce Online migration of multiple ﬁles and folders to their Amazon WorkDocs site. For more information, see Migrating ﬁles to Amazon WorkDocs in the Amazon WorkDocs Administration Guide. IP Allow List settings are available to ﬁlter access to your Amazon WorkDocs site by IP address range. For more information, see IP allow list settings in the Amazon WorkDocs Administration Guide. Hancom ThinkFree is available . Users can create and collaboratively edit Microsoft Oﬃce ﬁles from the Amazon WorkDocs web application. For more information, see Enabling Hancom ThinkFree in the Amazon WorkDocs Administration Guide. Open with Oﬃce Online is available. Users can collabora tively edit Microsoft Oﬃce ﬁles from the Amazon WorkDocs web applicati on. For more information, see Enabling Open with Oﬃce Online in the Amazon WorkDocs Administration Guide. October 22, 2018 June 21, 2018 June 6, 2018 93 Amazon WorkDocs Troubleshooting Administration Guide May 23, 2018 Troubleshooting topic added. For more information, see Troubleshooting Amazon WorkDocs issues in the Amazon WorkDocs Administr ation Guide. Change recovery bin retention period Recovery bin retention period
workdocs-ag-032	workdocs-ag.pdf	32	from the Amazon WorkDocs web application. For more information, see Enabling Hancom ThinkFree in the Amazon WorkDocs Administration Guide. Open with Oﬃce Online is available. Users can collabora tively edit Microsoft Oﬃce ﬁles from the Amazon WorkDocs web applicati on. For more information, see Enabling Open with Oﬃce Online in the Amazon WorkDocs Administration Guide. October 22, 2018 June 21, 2018 June 6, 2018 93 Amazon WorkDocs Troubleshooting Administration Guide May 23, 2018 Troubleshooting topic added. For more information, see Troubleshooting Amazon WorkDocs issues in the Amazon WorkDocs Administr ation Guide. Change recovery bin retention period Recovery bin retention period can be modiﬁed. For more February 27, 2018 information, see Recovery bin retention settings in the Amazon WorkDocs Administr ation Guide. 94
workdocs-api-001	workdocs-api.pdf	1	API Reference Amazon WorkDocs API Version 2016-05-01 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon WorkDocs API Reference Amazon WorkDocs: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon WorkDocs Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 3 AbortDocumentVersionUpload .................................................................................................................. 5 Request Syntax ........................................................................................................................................ 5 URI Request Parameters ........................................................................................................................ 5 Request Body ........................................................................................................................................... 6 Response Syntax ...................................................................................................................................... 6 Response Elements ................................................................................................................................. 6 Errors .......................................................................................................................................................... 6 See Also ..................................................................................................................................................... 7 ActivateUser ................................................................................................................................................... 8 Request Syntax ........................................................................................................................................ 8 URI Request Parameters ........................................................................................................................ 8 Request Body ........................................................................................................................................... 8 Response Syntax ...................................................................................................................................... 9 Response Elements ................................................................................................................................. 9 Errors ....................................................................................................................................................... 10 See Also .................................................................................................................................................. 10 AddResourcePermissions ........................................................................................................................... 12 Request Syntax ...................................................................................................................................... 12 URI Request Parameters ...................................................................................................................... 12 Request Body ......................................................................................................................................... 13 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 14 Errors ....................................................................................................................................................... 14 See Also .................................................................................................................................................. 15 CreateComment .......................................................................................................................................... 16 Request Syntax ...................................................................................................................................... 16 URI Request Parameters ...................................................................................................................... 16 Request Body ......................................................................................................................................... 17 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 19 Errors ....................................................................................................................................................... 19 See Also .................................................................................................................................................. 21 API Version 2016-05-01 iii Amazon WorkDocs API Reference CreateCustomMetadata ............................................................................................................................. 22 Request Syntax ...................................................................................................................................... 22 URI Request Parameters ...................................................................................................................... 22 Request Body ......................................................................................................................................... 23 Response Syntax ................................................................................................................................... 23 Response Elements ............................................................................................................................... 23 Errors ....................................................................................................................................................... 23 See Also .................................................................................................................................................. 24 CreateFolder ................................................................................................................................................ 26 Request Syntax ...................................................................................................................................... 26 URI Request Parameters ...................................................................................................................... 26 Request Body ......................................................................................................................................... 26 Response Syntax ................................................................................................................................... 27 Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 28 See Also .................................................................................................................................................. 29 CreateLabels ................................................................................................................................................ 31 Request Syntax ...................................................................................................................................... 31 URI Request Parameters ...................................................................................................................... 31 Request Body ......................................................................................................................................... 32 Response Syntax ................................................................................................................................... 32 Response Elements ............................................................................................................................... 32 Errors ....................................................................................................................................................... 32 See Also .................................................................................................................................................. 33 CreateNotiﬁcationSubscription ................................................................................................................ 34 Request Syntax ...................................................................................................................................... 34 URI Request Parameters ...................................................................................................................... 34 Request Body ......................................................................................................................................... 35 Response Syntax ................................................................................................................................... 35 Response Elements ............................................................................................................................... 36 Errors ....................................................................................................................................................... 36 See Also .................................................................................................................................................. 37 CreateUser .................................................................................................................................................... 38 Request Syntax ...................................................................................................................................... 38 URI Request Parameters ...................................................................................................................... 38 Request Body ......................................................................................................................................... 39 API Version 2016-05-01 iv Amazon WorkDocs API Reference Response Syntax ................................................................................................................................... 40 Response Elements ............................................................................................................................... 41 Errors ....................................................................................................................................................... 41 See Also .................................................................................................................................................. 42 DeactivateUser ............................................................................................................................................ 44 Request Syntax ...................................................................................................................................... 44 URI Request Parameters ...................................................................................................................... 44 Request Body ......................................................................................................................................... 44 Response Syntax ................................................................................................................................... 45 Response Elements ............................................................................................................................... 45 Errors ....................................................................................................................................................... 45 See Also .................................................................................................................................................. 46 DeleteComment .......................................................................................................................................... 47 Request Syntax ...................................................................................................................................... 47 URI Request Parameters ...................................................................................................................... 47 Request Body ......................................................................................................................................... 48 Response Syntax ................................................................................................................................... 48 Response Elements ............................................................................................................................... 48 Errors ....................................................................................................................................................... 48 See Also .................................................................................................................................................. 49 DeleteCustomMetadata ............................................................................................................................. 51 Request Syntax ...................................................................................................................................... 51 URI Request Parameters ...................................................................................................................... 51 Request Body ......................................................................................................................................... 52 Response Syntax ................................................................................................................................... 52 Response Elements ............................................................................................................................... 52 Errors ....................................................................................................................................................... 52 See Also .................................................................................................................................................. 53 DeleteDocument ......................................................................................................................................... 54 Request Syntax ...................................................................................................................................... 54 URI Request Parameters ...................................................................................................................... 54 Request Body ......................................................................................................................................... 54 Response Syntax ................................................................................................................................... 55 Response Elements ............................................................................................................................... 55 Errors ....................................................................................................................................................... 55 See Also .................................................................................................................................................. 56 API Version 2016-05-01 v Amazon WorkDocs API Reference DeleteDocumentVersion ........................................................................................................................... 57 Request Syntax ...................................................................................................................................... 57 URI Request Parameters ...................................................................................................................... 57 Request Body ......................................................................................................................................... 58 Response Syntax ................................................................................................................................... 58 Response Elements ............................................................................................................................... 58 Errors ....................................................................................................................................................... 58 See Also .................................................................................................................................................. 59 DeleteFolder ................................................................................................................................................ 61 Request Syntax ...................................................................................................................................... 61 URI Request Parameters ...................................................................................................................... 61 Request Body ......................................................................................................................................... 61 Response Syntax ................................................................................................................................... 62 Response Elements ............................................................................................................................... 62 Errors ....................................................................................................................................................... 62 See Also .................................................................................................................................................. 63 DeleteFolderContents ................................................................................................................................ 64 Request Syntax ...................................................................................................................................... 64 URI Request Parameters ...................................................................................................................... 64 Request Body ......................................................................................................................................... 64 Response Syntax ................................................................................................................................... 65 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 65 See Also .................................................................................................................................................. 66 DeleteLabels ................................................................................................................................................ 67 Request Syntax ...................................................................................................................................... 67 URI Request Parameters ...................................................................................................................... 67 Request Body ......................................................................................................................................... 68 Response Syntax ................................................................................................................................... 68 Response Elements ............................................................................................................................... 68 Errors ....................................................................................................................................................... 68 See Also .................................................................................................................................................. 69 DeleteNotiﬁcationSubscription ................................................................................................................ 70 Request Syntax ...................................................................................................................................... 70 URI Request Parameters ...................................................................................................................... 70 Request Body ......................................................................................................................................... 70 API Version 2016-05-01 vi Amazon WorkDocs API Reference Response Syntax ................................................................................................................................... 71 Response Elements ............................................................................................................................... 71 Errors ....................................................................................................................................................... 71 See Also .................................................................................................................................................. 71 DeleteUser .................................................................................................................................................... 73 Request Syntax ...................................................................................................................................... 73 URI Request Parameters ...................................................................................................................... 73 Request Body ......................................................................................................................................... 74 Response Syntax ................................................................................................................................... 74 Response Elements ............................................................................................................................... 74 Errors ....................................................................................................................................................... 74 See Also .................................................................................................................................................. 75 DescribeActivities ........................................................................................................................................ 76 Request Syntax ...................................................................................................................................... 76 URI Request Parameters ...................................................................................................................... 76 Request Body ......................................................................................................................................... 78 Response Syntax ................................................................................................................................... 78 Response Elements ............................................................................................................................... 80 Errors ....................................................................................................................................................... 81 See Also .................................................................................................................................................. 81 DescribeComments .................................................................................................................................... 83 Request Syntax ...................................................................................................................................... 83 URI Request Parameters ...................................................................................................................... 83 Request Body ......................................................................................................................................... 84 Response Syntax ................................................................................................................................... 84 Response Elements ............................................................................................................................... 85 Errors .......................................................................................................................................................
workdocs-api-002	workdocs-api.pdf	2	71 Response Elements ............................................................................................................................... 71 Errors ....................................................................................................................................................... 71 See Also .................................................................................................................................................. 71 DeleteUser .................................................................................................................................................... 73 Request Syntax ...................................................................................................................................... 73 URI Request Parameters ...................................................................................................................... 73 Request Body ......................................................................................................................................... 74 Response Syntax ................................................................................................................................... 74 Response Elements ............................................................................................................................... 74 Errors ....................................................................................................................................................... 74 See Also .................................................................................................................................................. 75 DescribeActivities ........................................................................................................................................ 76 Request Syntax ...................................................................................................................................... 76 URI Request Parameters ...................................................................................................................... 76 Request Body ......................................................................................................................................... 78 Response Syntax ................................................................................................................................... 78 Response Elements ............................................................................................................................... 80 Errors ....................................................................................................................................................... 81 See Also .................................................................................................................................................. 81 DescribeComments .................................................................................................................................... 83 Request Syntax ...................................................................................................................................... 83 URI Request Parameters ...................................................................................................................... 83 Request Body ......................................................................................................................................... 84 Response Syntax ................................................................................................................................... 84 Response Elements ............................................................................................................................... 85 Errors ....................................................................................................................................................... 86 See Also .................................................................................................................................................. 86 DescribeDocumentVersions ...................................................................................................................... 88 Request Syntax ...................................................................................................................................... 88 URI Request Parameters ...................................................................................................................... 88 Request Body ......................................................................................................................................... 89 Response Syntax ................................................................................................................................... 89 Response Elements ............................................................................................................................... 90 Errors ....................................................................................................................................................... 90 See Also .................................................................................................................................................. 91 API Version 2016-05-01 vii Amazon WorkDocs API Reference DescribeFolderContents ............................................................................................................................ 93 Request Syntax ...................................................................................................................................... 93 URI Request Parameters ...................................................................................................................... 93 Request Body ......................................................................................................................................... 94 Response Syntax ................................................................................................................................... 94 Response Elements ............................................................................................................................... 96 Errors ....................................................................................................................................................... 96 See Also .................................................................................................................................................. 97 DescribeGroups ........................................................................................................................................... 99 Request Syntax ...................................................................................................................................... 99 URI Request Parameters ...................................................................................................................... 99 Request Body ....................................................................................................................................... 100 Response Syntax ................................................................................................................................. 100 Response Elements ............................................................................................................................ 100 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 102 DescribeNotiﬁcationSubscriptions ........................................................................................................ 103 Request Syntax .................................................................................................................................... 103 URI Request Parameters ................................................................................................................... 103 Request Body ....................................................................................................................................... 104 Response Syntax ................................................................................................................................. 104 Response Elements ............................................................................................................................ 104 Errors ..................................................................................................................................................... 105 See Also ................................................................................................................................................ 105 DescribeResourcePermissions ................................................................................................................ 106 Request Syntax .................................................................................................................................... 106 URI Request Parameters ................................................................................................................... 106 Request Body ....................................................................................................................................... 107 Response Syntax ................................................................................................................................. 107 Response Elements ............................................................................................................................ 107 Errors ..................................................................................................................................................... 108 See Also ................................................................................................................................................ 109 DescribeRootFolders ................................................................................................................................ 110 Request Syntax .................................................................................................................................... 110 URI Request Parameters ................................................................................................................... 110 Request Body ....................................................................................................................................... 111 API Version 2016-05-01 viii Amazon WorkDocs API Reference Response Syntax ................................................................................................................................. 111 Response Elements ............................................................................................................................ 111 Errors ..................................................................................................................................................... 112 See Also ................................................................................................................................................ 113 DescribeUsers ............................................................................................................................................ 114 Request Syntax .................................................................................................................................... 114 URI Request Parameters ................................................................................................................... 114 Request Body ....................................................................................................................................... 116 Response Syntax ................................................................................................................................. 117 Response Elements ............................................................................................................................ 117 Errors ..................................................................................................................................................... 118 See Also ................................................................................................................................................ 119 GetCurrentUser ......................................................................................................................................... 121 Request Syntax .................................................................................................................................... 121 URI Request Parameters ................................................................................................................... 121 Request Body ....................................................................................................................................... 121 Response Syntax ................................................................................................................................. 121 Response Elements ............................................................................................................................ 122 Errors ..................................................................................................................................................... 122 See Also ................................................................................................................................................ 123 GetDocument ............................................................................................................................................ 125 Request Syntax .................................................................................................................................... 125 URI Request Parameters ................................................................................................................... 125 Request Body ....................................................................................................................................... 126 Response Syntax ................................................................................................................................. 126 Response Elements ............................................................................................................................ 127 Errors ..................................................................................................................................................... 127 See Also ................................................................................................................................................ 128 GetDocumentPath .................................................................................................................................... 130 Request Syntax .................................................................................................................................... 130 URI Request Parameters ................................................................................................................... 130 Request Body ....................................................................................................................................... 131 Response Syntax ................................................................................................................................. 131 Response Elements ............................................................................................................................ 131 Errors ..................................................................................................................................................... 132 See Also ................................................................................................................................................ 132 API Version 2016-05-01 ix Amazon WorkDocs API Reference GetDocumentVersion .............................................................................................................................. 134 Request Syntax .................................................................................................................................... 134 URI Request Parameters ................................................................................................................... 134 Request Body ....................................................................................................................................... 135 Response Syntax ................................................................................................................................. 135 Response Elements ............................................................................................................................ 136 Errors ..................................................................................................................................................... 136 See Also ................................................................................................................................................ 137 GetFolder ................................................................................................................................................... 139 Request Syntax .................................................................................................................................... 139 URI Request Parameters ................................................................................................................... 139 Request Body ....................................................................................................................................... 140 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 140 Errors ..................................................................................................................................................... 141 See Also ................................................................................................................................................ 142 GetFolderPath ........................................................................................................................................... 143 Request Syntax .................................................................................................................................... 143 URI Request Parameters ................................................................................................................... 143 Request Body ....................................................................................................................................... 144 Response Syntax ................................................................................................................................. 144 Response Elements ............................................................................................................................ 144 Errors ..................................................................................................................................................... 145 See Also ................................................................................................................................................ 145 GetResources ............................................................................................................................................. 147 Request Syntax .................................................................................................................................... 147 URI Request Parameters ................................................................................................................... 147 Request Body ....................................................................................................................................... 148 Response Syntax ................................................................................................................................. 148 Response Elements ............................................................................................................................ 149 Errors ..................................................................................................................................................... 150 See Also ................................................................................................................................................ 151 InitiateDocumentVersionUpload ........................................................................................................... 152 Request Syntax .................................................................................................................................... 152 URI Request Parameters ................................................................................................................... 152 Request Body ....................................................................................................................................... 153 API Version 2016-05-01 x Amazon WorkDocs API Reference Response Syntax ................................................................................................................................. 154 Response Elements ............................................................................................................................ 155 Errors ..................................................................................................................................................... 156 See Also ................................................................................................................................................ 157 RemoveAllResourcePermissions ............................................................................................................ 159 Request Syntax .................................................................................................................................... 159 URI Request Parameters ................................................................................................................... 159 Request Body ....................................................................................................................................... 159 Response Syntax ................................................................................................................................. 160 Response Elements ............................................................................................................................ 160 Errors ..................................................................................................................................................... 160 See Also ................................................................................................................................................ 160 RemoveResourcePermission ................................................................................................................... 162 Request Syntax .................................................................................................................................... 162 URI Request Parameters ................................................................................................................... 162 Request Body ....................................................................................................................................... 163 Response Syntax ................................................................................................................................. 163 Response Elements ............................................................................................................................ 163 Errors ..................................................................................................................................................... 163 See Also ................................................................................................................................................ 164 RestoreDocumentVersions ..................................................................................................................... 165 Request Syntax .................................................................................................................................... 165 URI Request Parameters ................................................................................................................... 165 Request Body ....................................................................................................................................... 165 Response Syntax ................................................................................................................................. 166 Response Elements ............................................................................................................................ 166 Errors ..................................................................................................................................................... 166 See Also ................................................................................................................................................ 167 SearchResources ....................................................................................................................................... 168 Request Syntax .................................................................................................................................... 168 URI Request Parameters ................................................................................................................... 169 Request Body ....................................................................................................................................... 169 Response Syntax ................................................................................................................................. 171 Response Elements ............................................................................................................................ 174 Errors ..................................................................................................................................................... 174 See Also ................................................................................................................................................ 175 API Version 2016-05-01 xi Amazon WorkDocs API Reference UpdateDocument ..................................................................................................................................... 176 Request Syntax .................................................................................................................................... 176 URI Request Parameters ................................................................................................................... 176 Request Body ....................................................................................................................................... 177 Response Syntax ................................................................................................................................. 177 Response Elements ............................................................................................................................ 178 Errors ..................................................................................................................................................... 178 See Also ................................................................................................................................................ 179 UpdateDocumentVersion ........................................................................................................................ 180 Request Syntax .................................................................................................................................... 180 URI Request Parameters ................................................................................................................... 180 Request Body ....................................................................................................................................... 181 Response Syntax ................................................................................................................................. 181 Response Elements ............................................................................................................................ 181 Errors ..................................................................................................................................................... 181 See Also ................................................................................................................................................ 183 UpdateFolder ............................................................................................................................................ 184 Request
workdocs-api-003	workdocs-api.pdf	3	.................................................................................................................................... 168 URI Request Parameters ................................................................................................................... 169 Request Body ....................................................................................................................................... 169 Response Syntax ................................................................................................................................. 171 Response Elements ............................................................................................................................ 174 Errors ..................................................................................................................................................... 174 See Also ................................................................................................................................................ 175 API Version 2016-05-01 xi Amazon WorkDocs API Reference UpdateDocument ..................................................................................................................................... 176 Request Syntax .................................................................................................................................... 176 URI Request Parameters ................................................................................................................... 176 Request Body ....................................................................................................................................... 177 Response Syntax ................................................................................................................................. 177 Response Elements ............................................................................................................................ 178 Errors ..................................................................................................................................................... 178 See Also ................................................................................................................................................ 179 UpdateDocumentVersion ........................................................................................................................ 180 Request Syntax .................................................................................................................................... 180 URI Request Parameters ................................................................................................................... 180 Request Body ....................................................................................................................................... 181 Response Syntax ................................................................................................................................. 181 Response Elements ............................................................................................................................ 181 Errors ..................................................................................................................................................... 181 See Also ................................................................................................................................................ 183 UpdateFolder ............................................................................................................................................ 184 Request Syntax .................................................................................................................................... 184 URI Request Parameters ................................................................................................................... 184 Request Body ....................................................................................................................................... 185 Response Syntax ................................................................................................................................. 185 Response Elements ............................................................................................................................ 186 Errors ..................................................................................................................................................... 186 See Also ................................................................................................................................................ 187 UpdateUser ................................................................................................................................................ 188 Request Syntax .................................................................................................................................... 188 URI Request Parameters ................................................................................................................... 188 Request Body ....................................................................................................................................... 189 Response Syntax ................................................................................................................................. 190 Response Elements ............................................................................................................................ 191 Errors ..................................................................................................................................................... 191 See Also ................................................................................................................................................ 193 Data Types ................................................................................................................................... 194 Activity ....................................................................................................................................................... 196 Contents ............................................................................................................................................... 196 See Also ................................................................................................................................................ 198 API Version 2016-05-01 xii Amazon WorkDocs API Reference Comment ................................................................................................................................................... 199 Contents ............................................................................................................................................... 199 See Also ................................................................................................................................................ 201 CommentMetadata .................................................................................................................................. 202 Contents ............................................................................................................................................... 202 See Also ................................................................................................................................................ 203 DateRangeType ......................................................................................................................................... 204 Contents ............................................................................................................................................... 204 See Also ................................................................................................................................................ 204 DocumentMetadata ................................................................................................................................. 205 Contents ............................................................................................................................................... 205 See Also ................................................................................................................................................ 207 DocumentVersionMetadata .................................................................................................................... 208 Contents ............................................................................................................................................... 208 See Also ................................................................................................................................................ 211 Filters .......................................................................................................................................................... 212 Contents ............................................................................................................................................... 212 See Also ................................................................................................................................................ 214 FolderMetadata ........................................................................................................................................ 215 Contents ............................................................................................................................................... 215 See Also ................................................................................................................................................ 217 GroupMetadata ......................................................................................................................................... 219 Contents ............................................................................................................................................... 219 See Also ................................................................................................................................................ 219 LongRangeType ........................................................................................................................................ 221 Contents ............................................................................................................................................... 221 See Also ................................................................................................................................................ 221 NotiﬁcationOptions ................................................................................................................................. 222 Contents ............................................................................................................................................... 222 See Also ................................................................................................................................................ 222 Participants ................................................................................................................................................ 223 Contents ............................................................................................................................................... 223 See Also ................................................................................................................................................ 223 PermissionInfo .......................................................................................................................................... 224 Contents ............................................................................................................................................... 224 See Also ................................................................................................................................................ 224 API Version 2016-05-01 xiii Amazon WorkDocs API Reference Principal ..................................................................................................................................................... 226 Contents ............................................................................................................................................... 226 See Also ................................................................................................................................................ 227 ResourceMetadata .................................................................................................................................... 228 Contents ............................................................................................................................................... 228 See Also ................................................................................................................................................ 230 ResourcePath ............................................................................................................................................. 231 Contents ............................................................................................................................................... 231 See Also ................................................................................................................................................ 231 ResourcePathComponent ....................................................................................................................... 232 Contents ............................................................................................................................................... 232 See Also ................................................................................................................................................ 232 ResponseItem ............................................................................................................................................ 234 Contents ............................................................................................................................................... 234 See Also ................................................................................................................................................ 235 SearchPrincipalType ................................................................................................................................. 236 Contents ............................................................................................................................................... 236 See Also ................................................................................................................................................ 236 SearchSortResult ...................................................................................................................................... 238 Contents ............................................................................................................................................... 238 See Also ................................................................................................................................................ 238 SharePrincipal ........................................................................................................................................... 240 Contents ............................................................................................................................................... 240 See Also ................................................................................................................................................ 241 ShareResult ................................................................................................................................................ 242 Contents ............................................................................................................................................... 242 See Also ................................................................................................................................................ 243 StorageRuleType ...................................................................................................................................... 244 Contents ............................................................................................................................................... 244 See Also ................................................................................................................................................ 244 Subscription ............................................................................................................................................... 246 Contents ............................................................................................................................................... 246 See Also ................................................................................................................................................ 247 UploadMetadata ....................................................................................................................................... 248 Contents ............................................................................................................................................... 248 See Also ................................................................................................................................................ 248 API Version 2016-05-01 xiv Amazon WorkDocs API Reference User ............................................................................................................................................................. 250 Contents ............................................................................................................................................... 250 See Also ................................................................................................................................................ 253 UserMetadata ............................................................................................................................................ 254 Contents ............................................................................................................................................... 254 See Also ................................................................................................................................................ 255 UserStorageMetadata .............................................................................................................................. 256 Contents ............................................................................................................................................... 256 See Also ................................................................................................................................................ 256 Common Parameters ................................................................................................................... 257 Common Errors ............................................................................................................................ 260 API Version 2016-05-01 xv Amazon WorkDocs Welcome API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. The Amazon WorkDocs API is designed for the following use cases: • File Migration: File migration applications are supported for users who want to migrate their ﬁles from an on-premises or oﬀ-premises ﬁle system or service. Users can insert ﬁles into a user directory structure, as well as allow for basic metadata changes, such as modiﬁcations to the permissions of ﬁles. • Security: Support security applications are supported for users who have additional security needs, such as anti virus or data loss prevention. The API actions, along with AWS CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target ﬁle. If the target ﬁle violates the policy, the application can also choose to email the user. • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with AWS CloudTrail, to replicate data for eDiscovery, backup, or analytical applications. All Amazon WorkDocs API actions are Amazon authenticated and certiﬁcate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify ﬁle permissions and upload any ﬁle to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the
workdocs-api-004	workdocs-api.pdf	4	also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify ﬁle permissions and upload any ﬁle to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model. Note The pricing for Amazon WorkDocs APIs varies depending on the API call type for these actions: • DELETE, CANCEL API Version 2016-05-01 1 Amazon WorkDocs API Reference • LIST (Describe) • READ (Get) • SEARCH • WRITE (Activate, Add, Create, Deactivate, Initiate, Update*) For information about Amazon WorkDocs API pricing, see Amazon WorkDocs Pricing. This document was last published on May 21, 2025. API Version 2016-05-01 2 Amazon WorkDocs Actions The following actions are supported: • AbortDocumentVersionUpload • ActivateUser • AddResourcePermissions • CreateComment • CreateCustomMetadata • CreateFolder • CreateLabels • CreateNotiﬁcationSubscription • CreateUser • DeactivateUser • DeleteComment • DeleteCustomMetadata • DeleteDocument • DeleteDocumentVersion • DeleteFolder • DeleteFolderContents • DeleteLabels • DeleteNotiﬁcationSubscription • DeleteUser • DescribeActivities • DescribeComments • DescribeDocumentVersions • DescribeFolderContents • DescribeGroups • DescribeNotiﬁcationSubscriptions • DescribeResourcePermissions • DescribeRootFolders API Reference API Version 2016-05-01 3 Amazon WorkDocs • DescribeUsers • GetCurrentUser • GetDocument • GetDocumentPath • GetDocumentVersion • GetFolder • GetFolderPath • GetResources • InitiateDocumentVersionUpload • RemoveAllResourcePermissions • RemoveResourcePermission • RestoreDocumentVersions • SearchResources • UpdateDocument • UpdateDocumentVersion • UpdateFolder • UpdateUser API Reference API Version 2016-05-01 4 Amazon WorkDocs API Reference AbortDocumentVersionUpload Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Aborts the upload of the speciﬁed document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so. Request Syntax DELETE /api/v1/documents/DocumentId/versions/VersionId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes VersionId The ID of the version. AbortDocumentVersionUpload API Version 2016-05-01 5 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. Request Body API Version 2016-05-01 6 API Reference Amazon WorkDocs HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 7 Amazon WorkDocs ActivateUser Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Activates the speciﬁed user. Only active users can access Amazon WorkDocs. Request Syntax POST /api/v1/users/UserId/activation HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. UserId The ID of the user. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes Request Body The request does not have a
workdocs-api-005	workdocs-api.pdf	5	no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Activates the speciﬁed user. Only active users can access Amazon WorkDocs. Request Syntax POST /api/v1/users/UserId/activation HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. UserId The ID of the user. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes Request Body The request does not have a request body. ActivateUser API Version 2016-05-01 8 API Reference Amazon WorkDocs Response Syntax HTTP/1.1 200 Content-type: application/json { "User": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. User The user information. Type: User object Response Syntax API Version 2016-05-01 9 Amazon WorkDocs Errors API Reference For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2016-05-01 10 Amazon WorkDocs • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 11 Amazon WorkDocs API Reference AddResourcePermissions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Creates a set of permissions for the speciﬁed folder or document. The resource permissions are overwritten if the principals already have diﬀerent permissions. Request Syntax POST /api/v1/resources/ResourceId/permissions HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "NotificationOptions": { "EmailMessage": "string", "SendEmail": boolean }, "Principals": [ { "Id": "string", "Role": "string", "Type": "string" } ] } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. AddResourcePermissions API Version 2016-05-01 12 Amazon WorkDocs ResourceId The ID of the resource. Length Constraints: Minimum length of 1. Maximum length of 128. API Reference Pattern: [\w+-.@]+ Required: Yes Request Body The request accepts the following data in JSON format. NotiﬁcationOptions The notiﬁcation options. Type: NotiﬁcationOptions object Required: No Principals The users, groups, or organization being granted permission. Type: Array of SharePrincipal objects Required: Yes Response Syntax HTTP/1.1 201 Content-type: application/json { "ShareResults": [ { "InviteePrincipalId": "string", "PrincipalId": "string", "Role": "string", "ShareId": "string", Request Body API Version 2016-05-01 13 Amazon WorkDocs API Reference "Status": "string", "StatusMessage": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ShareResults The share results. Type: Array of ShareResult objects Errors For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. Response Elements API Version 2016-05-01 14 Amazon WorkDocs HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. API Reference HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS
workdocs-api-006	workdocs-api.pdf	6	the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. Response Elements API Version 2016-05-01 14 Amazon WorkDocs HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. API Reference HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 15 Amazon WorkDocs CreateComment Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Adds a new comment to the speciﬁed document version. Request Syntax POST /api/v1/documents/DocumentId/versions/VersionId/comment HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "NotifyCollaborators": boolean, "ParentId": "string", "Text": "string", "ThreadId": "string", "Visibility": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. CreateComment API Version 2016-05-01 16 Amazon WorkDocs Pattern: [\w+-.@]+ Required: Yes VersionId The ID of the document version. Length Constraints: Minimum length of 1. Maximum length of 128. API Reference Pattern: [\w+-.@]+ Required: Yes Request Body The request accepts the following data in JSON format. NotifyCollaborators Set this parameter to TRUE to send an email out to the document collaborators after the comment is created. Type: Boolean Required: No ParentId The ID of the parent comment. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Text The text of the comment. Type: String Request Body API Version 2016-05-01 17 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ThreadId The ID of the root comment in the thread. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Visibility The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors. Type: String Valid Values: PUBLIC \| PRIVATE Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "Comment": { "CommentId": "string", "Contributor": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", Response Syntax API Version 2016-05-01 18 Amazon WorkDocs API Reference "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" }, "CreatedTimestamp": number, "ParentId": "string", "RecipientId": "string", "Status": "string", "Text": "string", "ThreadId": "string", "Visibility": "string" } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. Comment The comment that has been created. Type: Comment object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-05-01 19 Amazon WorkDocs API Reference DocumentLockedForCommentsException This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidCommentOperationException The requested operation is not allowed on the speciﬁed comment object. HTTP Status Code: 409 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. Errors API Version 2016-05-01 20 Amazon WorkDocs HTTP Status Code: 404 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP
workdocs-api-007	workdocs-api.pdf	7	503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. Errors API Version 2016-05-01 20 Amazon WorkDocs HTTP Status Code: 404 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 21 Amazon WorkDocs API Reference CreateCustomMetadata Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Adds one or more custom properties to the speciﬁed resource (a folder, document, or version). Request Syntax PUT /api/v1/resources/ResourceId/customMetadata?versionid=VersionId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "CustomMetadata": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. ResourceId The ID of the resource. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes CreateCustomMetadata API Version 2016-05-01 22 Amazon WorkDocs VersionId API Reference The ID of the version, if the custom metadata is being added to a document version. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Request Body The request accepts the following data in JSON format. CustomMetadata Custom metadata in the form of name-value pairs. Type: String to string map Map Entries: Maximum number of 8 items. Key Length Constraints: Minimum length of 1. Maximum length of 56. Key Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. Request Body API Version 2016-05-01 23 Amazon WorkDocs API Reference CustomMetadataLimitExceededException The limit has been reached on the number of custom properties for the speciﬁed resource. HTTP Status Code: 429 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-05-01 24 API Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 25 Amazon WorkDocs CreateFolder Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Creates a folder with the speciﬁed name and parent folder. Request Syntax POST /api/v1/folders HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "Name": "string", "ParentFolderId": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. Request Body The request accepts the following data in JSON format. Name The name of the new folder. Type: String CreateFolder API Version 2016-05-01 26 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No ParentFolderId The ID of the parent folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Response Syntax HTTP/1.1 201 Content-type: application/json { "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number } } Response Elements If the action is successful, the service sends
workdocs-api-008	workdocs-api.pdf	8	Name The name of the new folder. Type: String CreateFolder API Version 2016-05-01 26 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No ParentFolderId The ID of the parent folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Response Syntax HTTP/1.1 201 Content-type: application/json { "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number } } Response Elements If the action is successful, the service sends back an HTTP 201 response. Response Syntax API Version 2016-05-01 27 Amazon WorkDocs API Reference The following data is returned in JSON format by the service. Metadata The metadata of the folder. Type: FolderMetadata object Errors For information about the errors that are common to all actions, see Common Errors. ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 ConﬂictingOperationException Another operation is in progress on the resource that conﬂicts with the current operation. HTTP Status Code: 409 EntityAlreadyExistsException The resource already exists. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 LimitExceededException The maximum of 100,000 ﬁles and folders under the parent folder has been exceeded. Errors API Version 2016-05-01 28 API Reference Amazon WorkDocs HTTP Status Code: 409 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 29 Amazon WorkDocs API Reference See Also API Version 2016-05-01 30 Amazon WorkDocs CreateLabels Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Adds the speciﬁed list of labels to the given resource (a document or folder) Request Syntax PUT /api/v1/resources/ResourceId/labels HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "Labels": [ "string" ] } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. ResourceId The ID of the resource. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes CreateLabels API Version 2016-05-01 31 API Reference Amazon WorkDocs Request Body The request accepts the following data in JSON format. Labels List of labels to add to the resource. Type: Array of strings Array Members: Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 Request Body API Version 2016-05-01 32 Amazon WorkDocs ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 TooManyLabelsException The limit has been reached on the number of labels for the speciﬁed resource. API Reference HTTP Status Code: 429 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See
workdocs-api-009	workdocs-api.pdf	9	is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 33 Amazon WorkDocs API Reference CreateNotiﬁcationSubscription Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Conﬁgure Amazon WorkDocs to use Amazon SNS notiﬁcations. The endpoint receives a conﬁrmation message, and must conﬁrm the subscription. For more information, see Setting up notiﬁcations for an IAM user or role in the Amazon WorkDocs Developer Guide. Request Syntax POST /api/v1/organizations/OrganizationId/subscriptions HTTP/1.1 Content-type: application/json { "Endpoint": "string", "Protocol": "string", "SubscriptionType": "string" } URI Request Parameters The request uses the following URI parameters. OrganizationId The ID of the organization. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes CreateNotiﬁcationSubscription API Version 2016-05-01 34 Amazon WorkDocs Request Body The request accepts the following data in JSON format. Endpoint API Reference The endpoint to receive the notiﬁcations. If the protocol is HTTPS, the endpoint is a URL that begins with https. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: Yes Protocol The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST. Type: String Valid Values: HTTPS \| SQS Required: Yes SubscriptionType The notiﬁcation type. Type: String Valid Values: ALL Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "Subscription": { Request Body API Version 2016-05-01 35 Amazon WorkDocs API Reference "EndPoint": "string", "Protocol": "string", "SubscriptionId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Subscription The subscription. Type: Subscription object Errors For information about the errors that are common to all actions, see Common Errors. InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 TooManySubscriptionsException You've reached the limit on the number of subscriptions for the WorkDocs instance. HTTP Status Code: 429 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. Response Elements API Version 2016-05-01 36 Amazon WorkDocs HTTP Status Code: 404 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 37 Amazon WorkDocs CreateUser Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs. Request Syntax POST /api/v1/users HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "EmailAddress": "string", "GivenName": "string", "OrganizationId": "string", "Password": "string", "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "Surname": "string", "TimeZoneId": "string", "Username": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. CreateUser API Version 2016-05-01 38 API Reference Amazon WorkDocs Request Body The request accepts the following data in JSON format. EmailAddress The email address of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,} Required: No GivenName The given name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes OrganizationId The ID of the organization. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Password The password of the user. Type: String Length Constraints: Minimum length of 4. Maximum length of 32. Pattern: [\u0020-\u00FF]+ Request Body API Version 2016-05-01 39 API Reference Amazon WorkDocs Required: Yes StorageRule The amount of storage for the user. Type: StorageRuleType object Required: No Surname The surname of
workdocs-api-010	workdocs-api.pdf	10	Maximum length of 256. Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,} Required: No GivenName The given name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes OrganizationId The ID of the organization. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Password The password of the user. Type: String Length Constraints: Minimum length of 4. Maximum length of 32. Pattern: [\u0020-\u00FF]+ Request Body API Version 2016-05-01 39 API Reference Amazon WorkDocs Required: Yes StorageRule The amount of storage for the user. Type: StorageRuleType object Required: No Surname The surname of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes TimeZoneId The time zone ID of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Username The login name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w\-+.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z]+)? Required: Yes Response Syntax HTTP/1.1 201 Content-type: application/json Response Syntax API Version 2016-05-01 40 Amazon WorkDocs API Reference { "User": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. User The user information. Type: User object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-05-01 41 Amazon WorkDocs EntityAlreadyExistsException The resource already exists. HTTP Status Code: 409 FailedDependencyException API Reference The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2016-05-01 42 Amazon WorkDocs • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 43 Amazon WorkDocs DeactivateUser Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deactivates the speciﬁed user, which revokes the user's access to Amazon WorkDocs. Request Syntax DELETE /api/v1/users/UserId/activation HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. UserId The ID of the user. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes Request Body The request does not have a request body. DeactivateUser API Version 2016-05-01 44 Amazon WorkDocs Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 Response Syntax API Version 2016-05-01 45 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 46 Amazon WorkDocs DeleteComment Important API Reference Notice: New customer sign-ups and account
workdocs-api-011	workdocs-api.pdf	11	API Version 2016-05-01 45 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 46 Amazon WorkDocs DeleteComment Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deletes the speciﬁed comment from the document version. Request Syntax DELETE /api/v1/documents/DocumentId/versions/VersionId/comment/CommentId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. CommentId The ID of the comment. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. DeleteComment API Version 2016-05-01 47 Amazon WorkDocs Pattern: [\w+-.@]+ Required: Yes VersionId The ID of the document version. Length Constraints: Minimum length of 1. Maximum length of 128. API Reference Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DocumentLockedForCommentsException This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 Request Body API Version 2016-05-01 48 Amazon WorkDocs FailedDependencyException API Reference The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2016-05-01 49 Amazon WorkDocs • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 50 Amazon WorkDocs API Reference DeleteCustomMetadata Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deletes custom metadata from the speciﬁed resource. Request Syntax DELETE /api/v1/resources/ResourceId/customMetadata? deleteAll=DeleteAll&keys=Keys&versionId=VersionId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DeleteAll Flag to indicate removal of all custom metadata properties from the speciﬁed resource. Keys List of properties to remove. Array Members: Maximum number of 8 items. Length Constraints: Minimum length of 1. Maximum length of 56. Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* ResourceId The ID of the resource, either a document or folder. DeleteCustomMetadata API Version 2016-05-01 51 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes VersionId The ID of the version, if the custom metadata is being deleted from a document version. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 Request Body API Version 2016-05-01 52 Amazon WorkDocs ProhibitedStateException
workdocs-api-012	workdocs-api.pdf	12	[\w+-.@]+ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 Request Body API Version 2016-05-01 52 Amazon WorkDocs ProhibitedStateException API Reference The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 53 Amazon WorkDocs DeleteDocument Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Permanently deletes the speciﬁed document and its associated metadata. Request Syntax DELETE /api/v1/documents/DocumentId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. DeleteDocument API Version 2016-05-01 54 Amazon WorkDocs Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 ConﬂictingOperationException Another operation is in progress on the resource that conﬂicts with the current operation. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 LimitExceededException The maximum of 100,000 ﬁles and folders under the parent folder has been exceeded. HTTP Status Code: 409 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. Response Syntax API Version 2016-05-01 55 API Reference Amazon WorkDocs HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 56 Amazon WorkDocs API Reference DeleteDocumentVersion Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deletes a speciﬁc version of a document. Request Syntax DELETE /api/v1/documentVersions/DocumentId/versions/VersionId? deletePriorVersions=DeletePriorVersions HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DeletePriorVersions Deletes all versions of a document prior to the current version. Required: Yes DocumentId The ID of the document associated with the version being deleted. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes DeleteDocumentVersion API Version 2016-05-01 57 Amazon WorkDocs VersionId API Reference The ID of the version being deleted. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax
workdocs-api-013	workdocs-api.pdf	13	AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DeletePriorVersions Deletes all versions of a document prior to the current version. Required: Yes DocumentId The ID of the document associated with the version being deleted. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes DeleteDocumentVersion API Version 2016-05-01 57 Amazon WorkDocs VersionId API Reference The ID of the version being deleted. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 ConﬂictingOperationException Another operation is in progress on the resource that conﬂicts with the current operation. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 Request Body API Version 2016-05-01 58 Amazon WorkDocs FailedDependencyException API Reference The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidOperationException The operation is invalid. HTTP Status Code: 405 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2016-05-01 59 Amazon WorkDocs • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 60 Amazon WorkDocs DeleteFolder Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Permanently deletes the speciﬁed folder and its contents. Request Syntax DELETE /api/v1/folders/FolderId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. FolderId The ID of the folder. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. DeleteFolder API Version 2016-05-01 61 Amazon WorkDocs Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 ConﬂictingOperationException Another operation is in progress on the resource that conﬂicts with the current operation. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 LimitExceededException The maximum of 100,000 ﬁles and folders under the parent folder has been exceeded. HTTP Status Code: 409 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. Response Syntax API Version 2016-05-01 62 API Reference Amazon WorkDocs HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 63 Amazon WorkDocs API Reference DeleteFolderContents Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deletes the contents of the speciﬁed folder. Request Syntax DELETE /api/v1/folders/FolderId/contents HTTP/1.1 Authentication:
workdocs-api-014	workdocs-api.pdf	14	AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 63 Amazon WorkDocs API Reference DeleteFolderContents Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deletes the contents of the speciﬁed folder. Request Syntax DELETE /api/v1/folders/FolderId/contents HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. FolderId The ID of the folder. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. DeleteFolderContents API Version 2016-05-01 64 Amazon WorkDocs Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConﬂictingOperationException Another operation is in progress on the resource that conﬂicts with the current operation. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. Response Syntax API Version 2016-05-01 65 Amazon WorkDocs HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. API Reference HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 66 Amazon WorkDocs DeleteLabels Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deletes the speciﬁed list of labels from a resource. Request Syntax DELETE /api/v1/resources/ResourceId/labels?deleteAll=DeleteAll&labels=Labels HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DeleteAll Flag to request removal of all labels from the speciﬁed resource. Labels List of labels to delete from the resource. Array Members: Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* ResourceId The ID of the resource. DeleteLabels API Version 2016-05-01 67 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. Request Body API Version 2016-05-01 68 Amazon WorkDocs API Reference HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python •
workdocs-api-015	workdocs-api.pdf	15	Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 69 Amazon WorkDocs API Reference DeleteNotiﬁcationSubscription Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deletes the speciﬁed subscription from the speciﬁed organization. Request Syntax DELETE /api/v1/organizations/OrganizationId/subscriptions/SubscriptionId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. OrganizationId The ID of the organization. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes SubscriptionId The ID of the subscription. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes Request Body The request does not have a request body. DeleteNotiﬁcationSubscription API Version 2016-05-01 70 Amazon WorkDocs Response Syntax HTTP/1.1 200 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Response Syntax API Version 2016-05-01 71 API Reference Amazon WorkDocs • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 72 Amazon WorkDocs DeleteUser Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Deletes the speciﬁed user from a Simple AD or Microsoft AD directory. Important Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion. Request Syntax DELETE /api/v1/users/UserId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Do not set this ﬁeld when using administrative API actions, as in accessing the API using AWS credentials. Length Constraints: Minimum length of 1. Maximum length of 8199. UserId The ID of the user. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ DeleteUser API Version 2016-05-01 73 API Reference Amazon WorkDocs Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 Request Body API Version 2016-05-01 74 Amazon WorkDocs API Reference UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 75 Amazon WorkDocs DescribeActivities Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs.
workdocs-api-016	workdocs-api.pdf	16	See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 75 Amazon WorkDocs DescribeActivities Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the user activities in a speciﬁed time period. Request Syntax GET /api/v1/activities? activityTypes=ActivityTypes&endTime=EndTime&includeIndirectActivities=IncludeIndirectActivities&limit=Limit&marker=Marker&organizationId=OrganizationId&resourceId=ResourceId&startTime=StartTime&userId=UserId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. ActivityTypes Speciﬁes which activity types to include in the response. If this ﬁeld is left empty, all activity types are returned. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [\w,]+ AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. EndTime The timestamp that determines the end time of the activities. The response includes the activities performed before the speciﬁed timestamp. DescribeActivities API Version 2016-05-01 76 Amazon WorkDocs IncludeIndirectActivities API Reference Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity). Limit The maximum number of items to return. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. Length Constraints: Minimum length of 1. Maximum length of 12288. Pattern: [\u0000-\u00FF]+ OrganizationId The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ ResourceId The document or folder ID for which to describe activity types. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ StartTime The timestamp that determines the starting time of the activities. The response includes the activities performed after the speciﬁed timestamp. UserId The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests. URI Request Parameters API Version 2016-05-01 77 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Marker": "string", "UserActivities": [ { "CommentMetadata": { "CommentId": "string", "CommentStatus": "string", "Contributor": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" Request Body API Version 2016-05-01 78 Amazon WorkDocs API Reference }, "ContributorId": "string", "CreatedTimestamp": number, "RecipientId": "string" }, "Initiator": { "EmailAddress": "string", "GivenName": "string", "Id": "string", "Surname": "string", "Username": "string" }, "IsIndirectActivity": boolean, "OrganizationId": "string", "OriginalParent": { "Id": "string", "Name": "string", "OriginalName": "string", "Owner": { "EmailAddress": "string", "GivenName": "string", "Id": "string", "Surname": "string", "Username": "string" }, "ParentId": "string", "Type": "string", "VersionId": "string" }, "Participants": { "Groups": [ { "Id": "string", "Name": "string" } ], "Users": [ { "EmailAddress": "string", "GivenName": "string", "Id": "string", "Surname": "string", "Username": "string" } Response Syntax API Version 2016-05-01 79 API Reference Amazon WorkDocs ] }, "ResourceMetadata": { "Id": "string", "Name": "string", "OriginalName": "string", "Owner": { "EmailAddress": "string", "GivenName": "string", "Id": "string", "Surname": "string", "Username": "string" }, "ParentId": "string", "Type": "string", "VersionId": "string" }, "TimeStamp": number, "Type": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Marker The marker for the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 12288. Pattern: [\u0000-\u00FF]+ UserActivities The list of activities for the speciﬁed user and time period. Type: Array of Activity objects Response Elements API Version 2016-05-01 80 Amazon WorkDocs Errors API Reference For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403
workdocs-api-017	workdocs-api.pdf	17	time period. Type: Array of Activity objects Response Elements API Version 2016-05-01 80 Amazon WorkDocs Errors API Reference For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Errors API Version 2016-05-01 81 Amazon WorkDocs • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 82 Amazon WorkDocs DescribeComments Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. List all the comments for the speciﬁed document version. Request Syntax GET /api/v1/documents/DocumentId/versions/VersionId/comments?limit=Limit&marker=Marker HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Limit The maximum number of items to return. Valid Range: Minimum value of 1. Maximum value of 999. DescribeComments API Version 2016-05-01 83 Amazon WorkDocs Marker API Reference The marker for the next set of results. This marker was received from a previous call. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0000-\u00FF]+ VersionId The ID of the document version. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Comments": [ { "CommentId": "string", "Contributor": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { Request Body API Version 2016-05-01 84 Amazon WorkDocs API Reference "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" }, "CreatedTimestamp": number, "ParentId": "string", "RecipientId": "string", "Status": "string", "Text": "string", "ThreadId": "string", "Visibility": "string" } ], "Marker": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Comments The list of comments for the speciﬁed document version. Type: Array of Comment objects Marker The marker for the next set of results. This marker was received from a previous call. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0000-\u00FF]+ Response Elements API Version 2016-05-01 85 Amazon WorkDocs Errors API Reference For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2016-05-01 86 API Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 87 Amazon WorkDocs API Reference DescribeDocumentVersions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves the document
workdocs-api-018	workdocs-api.pdf	18	API Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 87 Amazon WorkDocs API Reference DescribeDocumentVersions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves the document versions for the speciﬁed document. By default, only active versions are returned. Request Syntax GET /api/v1/documents/DocumentId/versions? fields=Fields&include=Include&limit=Limit&marker=Marker HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Fields Specify "SOURCE" to include initialized versions and a URL for the source document. DescribeDocumentVersions API Version 2016-05-01 88 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w,]+ Include A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w,]+ Limit The maximum number of versions to return with this call. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. (You received this marker from a previous call.) Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "DocumentVersions": [ { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", Request Body API Version 2016-05-01 89 Amazon WorkDocs API Reference "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } } ], "Marker": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DocumentVersions The document versions. Type: Array of DocumentVersionMetadata objects Marker The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 Response Elements API Version 2016-05-01 90 Amazon WorkDocs FailedDependencyException API Reference The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 InvalidPasswordException The password is invalid. HTTP Status Code: 401 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-05-01 91 API Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 92 Amazon WorkDocs API Reference DescribeFolderContents Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the contents of the speciﬁed folder, including its documents and subfolders. By default, Amazon WorkDocs returns the ﬁrst 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents. Request Syntax GET /api/v1/folders/FolderId/contents? include=Include&limit=Limit&marker=Marker&order=Order&sort=Sort&type=Type HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. FolderId The ID of the folder. Length Constraints: Minimum length of 1. Maximum length of
workdocs-api-019	workdocs-api.pdf	19	By default, Amazon WorkDocs returns the ﬁrst 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents. Request Syntax GET /api/v1/folders/FolderId/contents? include=Include&limit=Limit&marker=Marker&order=Order&sort=Sort&type=Type HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. FolderId The ID of the folder. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes DescribeFolderContents API Version 2016-05-01 93 Amazon WorkDocs Include API Reference The contents to include. Specify "INITIALIZED" to include initialized documents. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w,]+ Limit The maximum number of items to return with this call. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. This marker was received from a previous call. Length Constraints: Minimum length of 1. Maximum length of 2048. Order The order for the contents of the folder. Valid Values: ASCENDING \| DESCENDING Sort The sorting criteria. Valid Values: DATE \| NAME Type The type of items. Valid Values: ALL \| DOCUMENT \| FOLDER Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json Request Body API Version 2016-05-01 94 API Reference Amazon WorkDocs { "Documents": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" } ], "Folders": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number Response Syntax API Version 2016-05-01 95 API Reference Amazon WorkDocs } ], "Marker": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Documents The documents in the speciﬁed folder. Type: Array of DocumentMetadata objects Folders The subfolders in the speciﬁed folder. Type: Array of FolderMetadata objects Marker The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 Response Elements API Version 2016-05-01 96 Amazon WorkDocs FailedDependencyException API Reference The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2016-05-01 97 Amazon WorkDocs • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 98 Amazon WorkDocs DescribeGroups Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the groups speciﬁed by the query. Groups are deﬁned by the underlying Active Directory. Request Syntax GET /api/v1/groups? limit=Limit&marker=Marker&organizationId=OrganizationId&searchQuery=SearchQuery HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. Limit The maximum number of items to return with this call. Valid Range: Minimum value of 1. Marker The marker for the next set of results. (You received this marker from a previous call.) Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0000-\u00FF]+ DescribeGroups API Version 2016-05-01 99 API Reference Amazon WorkDocs OrganizationId The ID of the organization. Length
workdocs-api-020	workdocs-api.pdf	20	Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. Limit The maximum number of items to return with this call. Valid Range: Minimum value of 1. Marker The marker for the next set of results. (You received this marker from a previous call.) Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0000-\u00FF]+ DescribeGroups API Version 2016-05-01 99 API Reference Amazon WorkDocs OrganizationId The ID of the organization. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ SearchQuery A query to describe groups by group name. Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [\u0020-\uFFFF]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Groups": [ { "Id": "string", "Name": "string" } ], "Marker": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Request Body API Version 2016-05-01 100 Amazon WorkDocs Groups The list of groups. Type: Array of GroupMetadata objects Marker API Reference The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\u0000-\u00FF]+ Errors For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 Errors API Version 2016-05-01 101 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 102 Amazon WorkDocs API Reference DescribeNotiﬁcationSubscriptions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Lists the speciﬁed notiﬁcation subscriptions. Request Syntax GET /api/v1/organizations/OrganizationId/subscriptions?limit=Limit&marker=Marker HTTP/1.1 URI Request Parameters The request uses the following URI parameters. Limit The maximum number of items to return with this call. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. (You received this marker from a previous call.) Length Constraints: Minimum length of 1. Maximum length of 2048. OrganizationId The ID of the organization. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes DescribeNotiﬁcationSubscriptions API Version 2016-05-01 103 API Reference Amazon WorkDocs Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Marker": "string", "Subscriptions": [ { "EndPoint": "string", "Protocol": "string", "SubscriptionId": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Marker The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Subscriptions The subscriptions. Type: Array of Subscription objects Array Members: Maximum number of 256 items. Request Body API Version 2016-05-01 104 Amazon WorkDocs Errors API Reference For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2016-05-01
workdocs-api-021	workdocs-api.pdf	21	HTTP Status Code: 503 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Errors API Version 2016-05-01 105 Amazon WorkDocs API Reference DescribeResourcePermissions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the permissions of a speciﬁed resource. Request Syntax GET /api/v1/resources/ResourceId/permissions? limit=Limit&marker=Marker&principalId=PrincipalId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. Limit The maximum number of items to return with this call. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. (You received this marker from a previous call) Length Constraints: Minimum length of 1. Maximum length of 2048. PrincipalId The ID of the principal to ﬁlter permissions by. DescribeResourcePermissions API Version 2016-05-01 106 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ ResourceId The ID of the resource. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Marker": "string", "Principals": [ { "Id": "string", "Roles": [ { "Role": "string", "Type": "string" } ], "Type": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Request Body API Version 2016-05-01 107 Amazon WorkDocs API Reference The following data is returned in JSON format by the service. Marker The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Principals The principals. Type: Array of Principal objects Errors For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 Errors API Version 2016-05-01 108 Amazon WorkDocs API Reference UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 109 Amazon WorkDocs API Reference DescribeRootFolders Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's ﬁles and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide. Request Syntax GET /api/v1/me/root?limit=Limit&marker=Marker HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Length Constraints: Minimum length of 1. Maximum length of 8199. Required: Yes Limit The maximum number of items to return. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. (You received this marker from a previous call.) DescribeRootFolders API Version 2016-05-01 110 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Folders":
workdocs-api-022	workdocs-api.pdf	22	AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Length Constraints: Minimum length of 1. Maximum length of 8199. Required: Yes Limit The maximum number of items to return. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. (You received this marker from a previous call.) DescribeRootFolders API Version 2016-05-01 110 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Folders": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number } ], "Marker": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Folders The user's special folders. Type: Array of FolderMetadata objects Request Body API Version 2016-05-01 111 Amazon WorkDocs Marker The marker for the next set of results. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 Errors API Version 2016-05-01 112 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 113 Amazon WorkDocs DescribeUsers Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the speciﬁed users. You can describe all users or ﬁlter the results (for example, by status or organization). By default, Amazon WorkDocs returns the ﬁrst 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results. Request Syntax GET /api/v1/users? fields=Fields&include=Include&limit=Limit&marker=Marker&order=Order&organizationId=OrganizationId&query=Query&sort=Sort&userIds=UserIds HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. Fields A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w,]+ DescribeUsers API Version 2016-05-01 114 Amazon WorkDocs Include API Reference The state of the users. Specify "ALL" to include inactive users. Valid Values: ALL \| ACTIVE_PENDING Limit The maximum number of items to return. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. (You received this marker from a previous call.) Length Constraints: Minimum length of 1. Maximum length of 2048. Order The order for the results. Valid Values: ASCENDING \| DESCENDING OrganizationId The ID of the organization. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Query A query to ﬁlter users by user name. Remember the following about the Userids and Query parameters: • If you don't use either parameter, the API returns a paginated list of all users on the site. • If you use both parameters, the API ignores the Query parameter. • The Userid parameter only returns the users that match a corresponding user ID. • Use commas to delimit multiple user IDs. For example: aws workdocs describe-users --region us-west-2 --user-ids 'S-1-5-21-3987873806-3646240316-3418290641-317967&d-9267750cd0,S-1-5-21-3987873806-3646240316-3418290641-317966&d-9267750cd0' URI Request Parameters API Version 2016-05-01 115 Amazon WorkDocs API Reference • We treat the ID ﬁeld as a string. We don't limit the number of IDs. The string can be 2000 characters long. Each ID is 59 characters. With the comma delimiter, the caller can supply up to 33 users in one request. • You don't need a delimiter for user-query. For multi-word queries, enclose the query in quotes. For example: aws workdocs describe-users
workdocs-api-023	workdocs-api.pdf	23	the users that match a corresponding user ID. • Use commas to delimit multiple user IDs. For example: aws workdocs describe-users --region us-west-2 --user-ids 'S-1-5-21-3987873806-3646240316-3418290641-317967&d-9267750cd0,S-1-5-21-3987873806-3646240316-3418290641-317966&d-9267750cd0' URI Request Parameters API Version 2016-05-01 115 Amazon WorkDocs API Reference • We treat the ID ﬁeld as a string. We don't limit the number of IDs. The string can be 2000 characters long. Each ID is 59 characters. With the comma delimiter, the caller can supply up to 33 users in one request. • You don't need a delimiter for user-query. For multi-word queries, enclose the query in quotes. For example: aws workdocs describe-users --region us-west-2 --organization-id d-9267750cd0 --user-query 'First Last' • You can use a maximum of 512 characters in a query. We don't limit the number of query terms as long as the string is less than 512 characters. • The Query parameter runs a "preﬁx" search for users by the GivenName, SurName, or UserName ﬁelds included in a CreateUser API call. For example, querying on Ma returns Márcia Oliveira, María García, and Mateo Jackson. If you use multiple characters, the API only returns data that matches all characters. For example, querying on Ma J only returns Mateo Jackson. Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [\u0020-\uFFFF]+ Sort The sorting criteria. Valid Values: USER_NAME \| FULL_NAME \| STORAGE_LIMIT \| USER_STATUS \| STORAGE_USED UserIds The IDs of the users. Length Constraints: Minimum length of 1. Maximum length of 2000. Pattern: [&\w+-.@, ]+ Request Body The request does not have a request body. Request Body API Version 2016-05-01 116 API Reference Amazon WorkDocs Response Syntax HTTP/1.1 200 Content-type: application/json { "Marker": "string", "TotalNumberOfUsers": number, "Users": [ { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-05-01 117 Amazon WorkDocs Marker API Reference The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. TotalNumberOfUsers This parameter has been deprecated. The total number of users included in the results. Type: Long Users The users. Type: Array of User objects Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 Errors API Version 2016-05-01 118 Amazon WorkDocs API Reference RequestedEntityTooLargeException The response is too large to return. The request must include a ﬁlter to reduce the size of the response. HTTP Status Code: 413 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 119 Amazon WorkDocs API Reference See Also API Version 2016-05-01 120 Amazon WorkDocs GetCurrentUser Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide. Request Syntax GET /api/v1/me HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Length Constraints: Minimum length of 1. Maximum length of 8199. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json GetCurrentUser API Version 2016-05-01 121 Amazon WorkDocs API Reference {
workdocs-api-024	workdocs-api.pdf	24	action for SigV4 (administrative API) clients. This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide. Request Syntax GET /api/v1/me HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Length Constraints: Minimum length of 1. Maximum length of 8199. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json GetCurrentUser API Version 2016-05-01 121 Amazon WorkDocs API Reference { "User": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. User Metadata of the user. Type: User object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-05-01 122 Amazon WorkDocs EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException API Reference The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2016-05-01 123 Amazon WorkDocs • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 124 Amazon WorkDocs GetDocument Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves details of a document. Request Syntax GET /api/v1/documents/DocumentId?includeCustomMetadata=IncludeCustomMetadata HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes IncludeCustomMetadata Set this to TRUE to include custom metadata in the response. GetDocument API Version 2016-05-01 125 Amazon WorkDocs Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "CustomMetadata": { "string" : "string" }, "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" } } Request Body API Reference API Version 2016-05-01 126 Amazon WorkDocs Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CustomMetadata The custom metadata on the document. Type: String to string map Map Entries: Maximum number of 8 items. Key Length Constraints: Minimum length of 1. Maximum length of 56. Key Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Metadata The metadata details of the document. Type: DocumentMetadata object Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 Response Elements API Version 2016-05-01 127 Amazon WorkDocs InvalidArgumentException The pagination marker or limit ﬁelds are not valid. API Reference HTTP Status Code: 400 InvalidPasswordException The password is invalid. HTTP Status Code: 401 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code:
workdocs-api-025	workdocs-api.pdf	25	Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 Response Elements API Version 2016-05-01 127 Amazon WorkDocs InvalidArgumentException The pagination marker or limit ﬁelds are not valid. API Reference HTTP Status Code: 400 InvalidPasswordException The password is invalid. HTTP Status Code: 401 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2016-05-01 128 Amazon WorkDocs • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 129 Amazon WorkDocs GetDocumentPath Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves the path information (the hierarchy from the root folder) for the requested document. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders. Request Syntax GET /api/v1/documents/DocumentId/path?fields=Fields&limit=Limit&marker=Marker HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes Fields A comma-separated list of values. Specify NAME to include the names of the parent folders. GetDocumentPath API Version 2016-05-01 130 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w,]+ Limit The maximum number of levels in the hierarchy to return. Valid Range: Minimum value of 1. Maximum value of 999. Marker This value is not supported. Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Path": { "Components": [ { "Id": "string", "Name": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Request Body API Version 2016-05-01 131 Amazon WorkDocs Path The path information. Type: ResourcePath object Errors API Reference For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2016-05-01 132 API Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 133 Amazon WorkDocs API Reference GetDocumentVersion Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves version metadata for the speciﬁed document. Request Syntax GET /api/v1/documents/DocumentId/versions/VersionId? fields=Fields&includeCustomMetadata=IncludeCustomMetadata HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Fields A comma-separated list of values. Specify "SOURCE" to include a URL for the source document. Length Constraints: Minimum
workdocs-api-026	workdocs-api.pdf	26	migration steps here: How to migrate data from Amazon WorkDocs. Retrieves version metadata for the speciﬁed document. Request Syntax GET /api/v1/documents/DocumentId/versions/VersionId? fields=Fields&includeCustomMetadata=IncludeCustomMetadata HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Fields A comma-separated list of values. Specify "SOURCE" to include a URL for the source document. Length Constraints: Minimum length of 1. Maximum length of 256. GetDocumentVersion API Version 2016-05-01 134 Amazon WorkDocs Pattern: [\w,]+ IncludeCustomMetadata Set this to TRUE to include custom metadata in the response. VersionId The version ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. API Reference Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "CustomMetadata": { "string" : "string" }, "Metadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, Request Body API Version 2016-05-01 135 Amazon WorkDocs API Reference "Status": "string", "Thumbnail": { "string" : "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CustomMetadata The custom metadata on the document version. Type: String to string map Map Entries: Maximum number of 8 items. Key Length Constraints: Minimum length of 1. Maximum length of 56. Key Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Metadata The version metadata. Type: DocumentVersionMetadata object Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. Response Elements API Version 2016-05-01 136 Amazon WorkDocs HTTP Status Code: 404 FailedDependencyException API Reference The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidPasswordException The password is invalid. HTTP Status Code: 401 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2016-05-01 137 API Reference Amazon WorkDocs • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 138 Amazon WorkDocs GetFolder Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves the metadata of the speciﬁed folder. Request Syntax GET /api/v1/folders/FolderId?includeCustomMetadata=IncludeCustomMetadata HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. FolderId The ID of the folder. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes IncludeCustomMetadata Set to TRUE to include custom metadata in the response. GetFolder API Version 2016-05-01 139 API Reference Amazon WorkDocs Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "CustomMetadata": { "string" : "string" }, "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CustomMetadata The custom metadata on the folder. Type: String to string map Map Entries: Maximum number of 8 items. Key Length Constraints: Minimum length of 1. Maximum length of 56. Request Body API Version 2016-05-01 140 Amazon WorkDocs API Reference Key Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Metadata The metadata of the folder. Type: FolderMetadata object Errors For information about the errors that
workdocs-api-027	workdocs-api.pdf	27	Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CustomMetadata The custom metadata on the folder. Type: String to string map Map Entries: Maximum number of 8 items. Key Length Constraints: Minimum length of 1. Maximum length of 56. Request Body API Version 2016-05-01 140 Amazon WorkDocs API Reference Key Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Value Length Constraints: Minimum length of 1. Maximum length of 256. Value Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Metadata The metadata of the folder. Type: FolderMetadata object Errors For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 Errors API Version 2016-05-01 141 Amazon WorkDocs API Reference UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 142 Amazon WorkDocs GetFolderPath Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves the path information (the hierarchy from the root folder) for the speciﬁed folder. By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names. Request Syntax GET /api/v1/folders/FolderId/path?fields=Fields&limit=Limit&marker=Marker HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. Fields A comma-separated list of values. Specify "NAME" to include the names of the parent folders. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w,]+ FolderId The ID of the folder. GetFolderPath API Version 2016-05-01 143 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes Limit The maximum number of levels in the hierarchy to return. Valid Range: Minimum value of 1. Maximum value of 999. Marker This value is not supported. Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Path": { "Components": [ { "Id": "string", "Name": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Request Body API Version 2016-05-01 144 Amazon WorkDocs Path The path information. Type: ResourcePath object Errors API Reference For information about the errors that are common to all actions, see Common Errors. EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2016-05-01 145 API Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 146 Amazon WorkDocs GetResources Important API Reference Notice:
workdocs-api-028	workdocs-api.pdf	28	HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2016-05-01 145 API Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 146 Amazon WorkDocs GetResources Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME. Request Syntax GET /api/v1/resources? collectionType=CollectionType&limit=Limit&marker=Marker&userId=UserId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken The Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. CollectionType The collection type. Valid Values: SHARED_WITH_ME Limit The maximum number of resources to return. Valid Range: Minimum value of 1. Maximum value of 999. Marker The marker for the next set of results. This marker was received from a previous call. GetResources API Version 2016-05-01 147 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. UserId The user ID for the resource collection. This is a required ﬁeld for accessing the API operation using IAM credentials. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Documents": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", Request Body API Version 2016-05-01 148 Amazon WorkDocs API Reference "Thumbnail": { "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" } ], "Folders": [ { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number } ], "Marker": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Documents The documents in the speciﬁed collection. Type: Array of DocumentMetadata objects Folders The folders in the speciﬁed folder. Type: Array of FolderMetadata objects Response Elements API Version 2016-05-01 149 Amazon WorkDocs Marker API Reference The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 Errors API Version 2016-05-01 150 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 151 Amazon WorkDocs API Reference InitiateDocumentVersionUpload Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Creates a new document object and version object. The client speciﬁes the parent folder ID and name of the document to upload. The ID is optionally speciﬁed when creating a new version of an existing document. This is the ﬁrst step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion. To cancel the document upload, call AbortDocumentVersionUpload. Request Syntax POST /api/v1/documents HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "DocumentSizeInBytes": number, "Id": "string", "Name":
workdocs-api-029	workdocs-api.pdf	29	Learn about migration steps here: How to migrate data from Amazon WorkDocs. Creates a new document object and version object. The client speciﬁes the parent folder ID and name of the document to upload. The ID is optionally speciﬁed when creating a new version of an existing document. This is the ﬁrst step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion. To cancel the document upload, call AbortDocumentVersionUpload. Request Syntax POST /api/v1/documents HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "DocumentSizeInBytes": number, "Id": "string", "Name": "string", "ParentFolderId": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. InitiateDocumentVersionUpload API Version 2016-05-01 152 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 8199. Request Body The request accepts the following data in JSON format. ContentCreatedTimestamp The timestamp when the content of the document was originally created. Type: Timestamp Required: No ContentModiﬁedTimestamp The timestamp when the content of the document was modiﬁed. Type: Timestamp Required: No ContentType The content type of the document. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No DocumentSizeInBytes The size of the document, in bytes. Type: Long Required: No Id The ID of the document. Type: String Request Body API Version 2016-05-01 153 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Name The name of the document. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No ParentFolderId The ID of the parent folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "Metadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", Response Syntax API Version 2016-05-01 154 Amazon WorkDocs API Reference "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" }, "UploadMetadata": { "SignedHeaders": { "string" : "string" }, "UploadUrl": "string" } } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. Metadata The document metadata. Type: DocumentMetadata object UploadMetadata The upload metadata. Type: UploadMetadata object Response Elements API Version 2016-05-01 155 Amazon WorkDocs Errors API Reference For information about the errors that are common to all actions, see Common Errors. DraftUploadOutOfSyncException This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client. HTTP Status Code: 409 EntityAlreadyExistsException The resource already exists. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 InvalidPasswordException The password is invalid. HTTP Status Code: 401 LimitExceededException The maximum of 100,000 ﬁles and folders under the parent folder has been exceeded. HTTP Status Code: 409 Errors API Version 2016-05-01 156 Amazon WorkDocs ProhibitedStateException API Reference The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ResourceAlreadyCheckedOutException The resource is already checked out. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 StorageLimitExceededException The storage limit has been exceeded. HTTP Status Code: 409 StorageLimitWillExceedException The storage limit will be exceeded. HTTP Status Code: 413 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-05-01 157 API Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 158 Amazon WorkDocs API Reference RemoveAllResourcePermissions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Removes all the permissions
workdocs-api-030	workdocs-api.pdf	30	Reference Amazon WorkDocs • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 158 Amazon WorkDocs API Reference RemoveAllResourcePermissions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Removes all the permissions from the speciﬁed resource. Request Syntax DELETE /api/v1/resources/ResourceId/permissions HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. ResourceId The ID of the resource. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. RemoveAllResourcePermissions API Version 2016-05-01 159 Amazon WorkDocs Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface Response Syntax API Version 2016-05-01 160 API Reference Amazon WorkDocs • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 161 Amazon WorkDocs API Reference RemoveResourcePermission Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Removes the permission for the speciﬁed principal from the speciﬁed resource. Request Syntax DELETE /api/v1/resources/ResourceId/permissions/PrincipalId?type=PrincipalType HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. PrincipalId The principal ID of the resource. Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes PrincipalType The principal type of the resource. Valid Values: USER \| GROUP \| INVITE \| ANONYMOUS \| ORGANIZATION RemoveResourcePermission API Version 2016-05-01 162 Amazon WorkDocs ResourceId The ID of the resource. Length Constraints: Minimum length of 1. Maximum length of 128. API Reference Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. Request Body API Version 2016-05-01 163 Amazon WorkDocs HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. API Reference HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 164 Amazon WorkDocs API Reference RestoreDocumentVersions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Recovers a deleted version of an Amazon WorkDocs document. Request Syntax POST /api/v1/documentVersions/restore/DocumentId HTTP/1.1 Authentication: AuthenticationToken
workdocs-api-031	workdocs-api.pdf	31	.NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 164 Amazon WorkDocs API Reference RestoreDocumentVersions Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Recovers a deleted version of an Amazon WorkDocs document. Request Syntax POST /api/v1/documentVersions/restore/DocumentId HTTP/1.1 Authentication: AuthenticationToken URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request does not have a request body. RestoreDocumentVersions API Version 2016-05-01 165 Amazon WorkDocs Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 ConﬂictingOperationException Another operation is in progress on the resource that conﬂicts with the current operation. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidOperationException The operation is invalid. HTTP Status Code: 405 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. Response Syntax API Version 2016-05-01 166 Amazon WorkDocs API Reference HTTP Status Code: 409 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 167 Amazon WorkDocs SearchResources Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Searches metadata and the content of folders, documents, document versions, and comments. Request Syntax POST /api/v1/search HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "AdditionalResponseFields": [ "string" ], "Filters": { "AncestorIds": [ "string" ], "ContentCategories": [ "string" ], "CreatedRange": { "EndValue": number, "StartValue": number }, "Labels": [ "string" ], "ModifiedRange": { "EndValue": number, "StartValue": number }, "Principals": [ { "Id": "string", "Roles": [ "string" ] } ], "ResourceTypes": [ "string" ], "SearchCollectionTypes": [ "string" ], "SizeRange": { "EndValue": number, "StartValue": number }, SearchResources API Version 2016-05-01 168 Amazon WorkDocs API Reference "TextLocales": [ "string" ] }, "Limit": number, "Marker": "string", "OrderBy": [ { "Field": "string", "Order": "string" } ], "OrganizationId": "string", "QueryScopes": [ "string" ], "QueryText": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. Request Body The request accepts the following data in JSON format. AdditionalResponseFields A list of attributes to include in the response. Used to request ﬁelds that are not normally returned in a standard response. Type: Array of strings Valid Values: WEBURL Required: No URI Request Parameters API Version 2016-05-01 169 API Reference Amazon WorkDocs Filters Filters results based on entity metadata. Type: Filters object Required: No Limit Max results count per page. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No Marker The marker for the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\d]+ Required: No OrderBy Order by results in one or more categories. Type: Array of SearchSortResult objects Array Members: Maximum number of 1 item. Required: No OrganizationId Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Request Body API Version 2016-05-01 170 Amazon WorkDocs Pattern: [&\w+-.@]+ Required: No QueryScopes API Reference Filter based on the text ﬁeld type. A Folder has only
workdocs-api-032	workdocs-api.pdf	32	the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\d]+ Required: No OrderBy Order by results in one or more categories. Type: Array of SearchSortResult objects Array Members: Maximum number of 1 item. Required: No OrganizationId Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Request Body API Version 2016-05-01 170 Amazon WorkDocs Pattern: [&\w+-.@]+ Required: No QueryScopes API Reference Filter based on the text ﬁeld type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content Type: Array of strings Array Members: Maximum number of 2 items. Valid Values: NAME \| CONTENT Required: No QueryText The String to search for. Searches across diﬀerent text ﬁelds based on request parameters. Use double quotes around the query string for exact phrase matches. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [\u0020-\uFFFF]+ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Items": [ { "CommentMetadata": { "CommentId": "string", "CommentStatus": "string", "Contributor": { "CreatedTimestamp": number, "EmailAddress": "string", "GivenName": "string", Response Syntax API Version 2016-05-01 171 Amazon WorkDocs API Reference "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" }, "ContributorId": "string", "CreatedTimestamp": number, "RecipientId": "string" }, "DocumentMetadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { Response Syntax API Version 2016-05-01 172 Amazon WorkDocs API Reference "string" : "string" } }, "ModifiedTimestamp": number, "ParentFolderId": "string", "ResourceState": "string" }, "DocumentVersionMetadata": { "ContentCreatedTimestamp": number, "ContentModifiedTimestamp": number, "ContentType": "string", "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "ModifiedTimestamp": number, "Name": "string", "Signature": "string", "Size": number, "Source": { "string" : "string" }, "Status": "string", "Thumbnail": { "string" : "string" } }, "FolderMetadata": { "CreatedTimestamp": number, "CreatorId": "string", "Id": "string", "Labels": [ "string" ], "LatestVersionSize": number, "ModifiedTimestamp": number, "Name": "string", "ParentFolderId": "string", "ResourceState": "string", "Signature": "string", "Size": number }, "ResourceType": "string", "WebUrl": "string" } ], "Marker": "string" Response Syntax API Version 2016-05-01 173 Amazon WorkDocs } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Items List of Documents, Folders, Comments, and Document Versions matching the query. Type: Array of ResponseItem objects Array Members: Maximum number of 100 items. Marker The marker to use when requesting the next set of results. If there are no additional results, the string is empty. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: [\d]+ Errors For information about the errors that are common to all actions, see Common Errors. InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 Response Elements API Version 2016-05-01 174 Amazon WorkDocs API Reference UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 175 Amazon WorkDocs UpdateDocument Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Updates the speciﬁed attributes of a document. The user must have access to both the document and its parent folder, if applicable. Request Syntax PATCH /api/v1/documents/DocumentId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "Name": "string", "ParentFolderId": "string", "ResourceState": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ UpdateDocument API Version 2016-05-01 176 Amazon WorkDocs Required: Yes Request Body API Reference The request accepts the following data in JSON
workdocs-api-033	workdocs-api.pdf	33	the document and its parent folder, if applicable. Request Syntax PATCH /api/v1/documents/DocumentId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "Name": "string", "ParentFolderId": "string", "ResourceState": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ UpdateDocument API Version 2016-05-01 176 Amazon WorkDocs Required: Yes Request Body API Reference The request accepts the following data in JSON format. Name The name of the document. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No ParentFolderId The ID of the parent folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No ResourceState The resource state of the document. Only ACTIVE and RECYCLED are supported. Type: String Valid Values: ACTIVE \| RESTORING \| RECYCLING \| RECYCLED Required: No Response Syntax HTTP/1.1 200 Request Body API Version 2016-05-01 177 Amazon WorkDocs Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 ConﬂictingOperationException Another operation is in progress on the resource that conﬂicts with the current operation. HTTP Status Code: 409 EntityAlreadyExistsException The resource already exists. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 LimitExceededException The maximum of 100,000 ﬁles and folders under the parent folder has been exceeded. HTTP Status Code: 409 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. Response Elements API Version 2016-05-01 178 API Reference Amazon WorkDocs HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 179 Amazon WorkDocs API Reference UpdateDocumentVersion Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Changes the status of the document version to ACTIVE. Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload. Request Syntax PATCH /api/v1/documents/DocumentId/versions/VersionId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "VersionStatus": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. DocumentId The ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. UpdateDocumentVersion API Version 2016-05-01 180 API Reference Amazon WorkDocs Pattern: [\w+-.@]+ Required: Yes VersionId The version ID of the document. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Request Body The request accepts the following data in JSON format. VersionStatus The status of the version. Type: String Valid Values: ACTIVE Required: No Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. Request Body API Version 2016-05-01 181 Amazon WorkDocs API Reference ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidOperationException The operation is invalid. HTTP Status Code: 405 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation
workdocs-api-034	workdocs-api.pdf	34	Body API Version 2016-05-01 181 Amazon WorkDocs API Reference ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 InvalidOperationException The operation is invalid. HTTP Status Code: 405 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 Errors API Version 2016-05-01 182 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 183 Amazon WorkDocs UpdateFolder Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Updates the speciﬁed attributes of the speciﬁed folder. The user must have access to both the folder and its parent folder, if applicable. Request Syntax PATCH /api/v1/folders/FolderId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "Name": "string", "ParentFolderId": "string", "ResourceState": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. FolderId The ID of the folder. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ UpdateFolder API Version 2016-05-01 184 API Reference Amazon WorkDocs Required: Yes Request Body The request accepts the following data in JSON format. Name The name of the folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No ParentFolderId The ID of the parent folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No ResourceState The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API. Type: String Valid Values: ACTIVE \| RESTORING \| RECYCLING \| RECYCLED Required: No Response Syntax HTTP/1.1 200 Request Body API Version 2016-05-01 185 Amazon WorkDocs Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. ConcurrentModiﬁcationException The resource hierarchy is changing. HTTP Status Code: 409 ConﬂictingOperationException Another operation is in progress on the resource that conﬂicts with the current operation. HTTP Status Code: 409 EntityAlreadyExistsException The resource already exists. HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 LimitExceededException The maximum of 100,000 ﬁles and folders under the parent folder has been exceeded. HTTP Status Code: 409 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. Response Elements API Version 2016-05-01 186 API Reference Amazon WorkDocs HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 187 Amazon WorkDocs UpdateUser Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Updates the speciﬁed attributes of the speciﬁed user, and grants or revokes administrative privileges to the Amazon WorkDocs site. Request Syntax PATCH /api/v1/users/UserId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "GivenName": "string", "GrantPoweruserPrivileges": "string", "Locale": "string", "StorageRule": { "StorageAllocatedInBytes":
workdocs-api-035	workdocs-api.pdf	35	JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 187 Amazon WorkDocs UpdateUser Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Updates the speciﬁed attributes of the speciﬁed user, and grants or revokes administrative privileges to the Amazon WorkDocs site. Request Syntax PATCH /api/v1/users/UserId HTTP/1.1 Authentication: AuthenticationToken Content-type: application/json { "GivenName": "string", "GrantPoweruserPrivileges": "string", "Locale": "string", "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "Surname": "string", "TimeZoneId": "string", "Type": "string" } URI Request Parameters The request uses the following URI parameters. AuthenticationToken Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. Length Constraints: Minimum length of 1. Maximum length of 8199. UpdateUser API Version 2016-05-01 188 Amazon WorkDocs UserId The ID of the user. Length Constraints: Minimum length of 1. Maximum length of 256. API Reference Pattern: [&\w+-.@]+ Required: Yes Request Body The request accepts the following data in JSON format. GivenName The given name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No GrantPoweruserPrivileges Boolean value to determine whether the user is granted Power user privileges. Type: String Valid Values: TRUE \| FALSE Required: No Locale The locale of the user. Type: String Valid Values: en \| fr \| ko \| de \| es \| ja \| ru \| zh_CN \| zh_TW \| pt_BR \| default Required: No Request Body API Version 2016-05-01 189 API Reference Amazon WorkDocs StorageRule The amount of storage for the user. Type: StorageRuleType object Required: No Surname The surname of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No TimeZoneId The time zone ID of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Type The type of the user. Type: String Valid Values: USER \| ADMIN \| POWERUSER \| MINIMALUSER \| WORKSPACESUSER Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "User": { "CreatedTimestamp": number, Response Syntax API Version 2016-05-01 190 Amazon WorkDocs API Reference "EmailAddress": "string", "GivenName": "string", "Id": "string", "Locale": "string", "ModifiedTimestamp": number, "OrganizationId": "string", "RecycleBinFolderId": "string", "RootFolderId": "string", "Status": "string", "Storage": { "StorageRule": { "StorageAllocatedInBytes": number, "StorageType": "string" }, "StorageUtilizedInBytes": number }, "Surname": "string", "TimeZoneId": "string", "Type": "string", "Username": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. User The user information. Type: User object Errors For information about the errors that are common to all actions, see Common Errors. DeactivatingLastSystemUserException The last user in the organization is being deactivated. Response Elements API Version 2016-05-01 191 Amazon WorkDocs HTTP Status Code: 409 EntityNotExistsException The resource does not exist. HTTP Status Code: 404 FailedDependencyException API Reference The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory. HTTP Status Code: 424 IllegalUserStateException The user is undergoing transfer of ownership. HTTP Status Code: 409 InvalidArgumentException The pagination marker or limit ﬁelds are not valid. HTTP Status Code: 400 ProhibitedStateException The speciﬁed document version is not in the INITIALIZED state. HTTP Status Code: 409 ServiceUnavailableException One or more of the dependencies is unavailable. HTTP Status Code: 503 UnauthorizedOperationException The operation is not permitted. HTTP Status Code: 403 UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource. Errors API Version 2016-05-01 192 Amazon WorkDocs HTTP Status Code: 404 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-05-01 193 Amazon WorkDocs Data Types API Reference The Amazon WorkDocs API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • Activity • Comment • CommentMetadata • DateRangeType • DocumentMetadata • DocumentVersionMetadata • Filters • FolderMetadata • GroupMetadata • LongRangeType • NotiﬁcationOptions • Participants • PermissionInfo • Principal • ResourceMetadata • ResourcePath • ResourcePathComponent • ResponseItem • SearchPrincipalType • SearchSortResult API Version 2016-05-01 194 Amazon WorkDocs • SharePrincipal • ShareResult • StorageRuleType •
workdocs-api-036	workdocs-api.pdf	36	The Amazon WorkDocs API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • Activity • Comment • CommentMetadata • DateRangeType • DocumentMetadata • DocumentVersionMetadata • Filters • FolderMetadata • GroupMetadata • LongRangeType • NotiﬁcationOptions • Participants • PermissionInfo • Principal • ResourceMetadata • ResourcePath • ResourcePathComponent • ResponseItem • SearchPrincipalType • SearchSortResult API Version 2016-05-01 194 Amazon WorkDocs • SharePrincipal • ShareResult • StorageRuleType • Subscription • UploadMetadata • User • UserMetadata • UserStorageMetadata API Reference API Version 2016-05-01 195 Amazon WorkDocs Activity Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the activity information. Contents CommentMetadata Metadata of the commenting activity. This is an optional ﬁeld and is ﬁlled for commenting activities. Type: CommentMetadata object Required: No Initiator The user who performed the action. Type: UserMetadata object Required: No IsIndirectActivity Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity). Type: Boolean Required: No OrganizationId The ID of the organization. Activity API Version 2016-05-01 196 Amazon WorkDocs Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No OriginalParent The original parent of the resource. This is an optional ﬁeld and is ﬁlled for move activities. Type: ResourceMetadata object Required: No Participants The list of users or groups impacted by this action. This is an optional ﬁeld and is ﬁlled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED. Type: Participants object Required: No ResourceMetadata The metadata of the resource involved in the user action. Type: ResourceMetadata object Required: No TimeStamp The timestamp when the action was performed. Type: Timestamp Required: No Type The activity type. Type: String Contents API Version 2016-05-01 197 Amazon WorkDocs API Reference Valid Values: DOCUMENT_CHECKED_IN \| DOCUMENT_CHECKED_OUT \| DOCUMENT_RENAMED \| DOCUMENT_VERSION_UPLOADED \| DOCUMENT_VERSION_DELETED \| DOCUMENT_VERSION_VIEWED \| DOCUMENT_VERSION_DOWNLOADED \| DOCUMENT_RECYCLED \| DOCUMENT_RESTORED \| DOCUMENT_REVERTED \| DOCUMENT_SHARED \| DOCUMENT_UNSHARED \| DOCUMENT_SHARE_PERMISSION_CHANGED \| DOCUMENT_SHAREABLE_LINK_CREATED \| DOCUMENT_SHAREABLE_LINK_REMOVED \| DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED \| DOCUMENT_MOVED \| DOCUMENT_COMMENT_ADDED \| DOCUMENT_COMMENT_DELETED \| DOCUMENT_ANNOTATION_ADDED \| DOCUMENT_ANNOTATION_DELETED \| FOLDER_CREATED \| FOLDER_DELETED \| FOLDER_RENAMED \| FOLDER_RECYCLED \| FOLDER_RESTORED \| FOLDER_SHARED \| FOLDER_UNSHARED \| FOLDER_SHARE_PERMISSION_CHANGED \| FOLDER_SHAREABLE_LINK_CREATED \| FOLDER_SHAREABLE_LINK_REMOVED \| FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED \| FOLDER_MOVED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 198 Amazon WorkDocs Comment Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes a comment. Contents CommentId The ID of the comment. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: Yes Contributor The details of the user who made the comment. Type: User object Required: No CreatedTimestamp The time that the comment was created. Type: Timestamp Required: No ParentId The ID of the parent comment. Comment API Version 2016-05-01 199 Amazon WorkDocs Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No RecipientId If the comment is a reply to another user's comment, this ﬁeld contains the user ID of the user being replied to. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Status The status of the comment. Type: String Valid Values: DRAFT \| PUBLISHED \| DELETED Required: No Text The text of the comment. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ThreadId The ID of the root comment in the thread. Type: String Contents API Version 2016-05-01 200 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Visibility The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors. Type: String Valid Values: PUBLIC \| PRIVATE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 201 Amazon WorkDocs CommentMetadata Important API Reference
workdocs-api-037	workdocs-api.pdf	37	128. Pattern: [\w+-.@]+ Required: No Visibility The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors. Type: String Valid Values: PUBLIC \| PRIVATE Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 201 Amazon WorkDocs CommentMetadata Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the metadata of a comment. Contents CommentId The ID of the comment. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No CommentStatus The status of the comment. Type: String Valid Values: DRAFT \| PUBLISHED \| DELETED Required: No Contributor The user who made the comment. Type: User object Required: No ContributorId The ID of the user who made the comment. CommentMetadata API Version 2016-05-01 202 Amazon WorkDocs Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No CreatedTimestamp The timestamp that the comment was created. Type: Timestamp Required: No RecipientId The ID of the user being replied to. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 203 Amazon WorkDocs DateRangeType Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Filters results based on timestamp range (in epochs). Contents EndValue Timestamp range end value (in epochs). Type: Timestamp Required: No StartValue Timestamp range start value (in epochs) Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DateRangeType API Version 2016-05-01 204 Amazon WorkDocs DocumentMetadata Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the document. Contents CreatedTimestamp The time when the document was created. Type: Timestamp Required: No CreatorId The ID of the creator. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Id The ID of the document. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No DocumentMetadata API Version 2016-05-01 205 API Reference Amazon WorkDocs Labels List of labels on the document. Type: Array of strings Array Members: Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Required: No LatestVersionMetadata The latest version of the document. Type: DocumentVersionMetadata object Required: No ModiﬁedTimestamp The time when the document was updated. Type: Timestamp Required: No ParentFolderId The ID of the parent folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No ResourceState The resource state. Type: String Contents API Version 2016-05-01 206 Amazon WorkDocs API Reference Valid Values: ACTIVE \| RESTORING \| RECYCLING \| RECYCLED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 207 Amazon WorkDocs API Reference DocumentVersionMetadata Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes a version of a document. Contents ContentCreatedTimestamp The timestamp when the content of the document was originally created. Type: Timestamp Required: No ContentModiﬁedTimestamp The timestamp when the content of the document was modiﬁed. Type: Timestamp Required: No ContentType The content type of the document. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No CreatedTimestamp The timestamp when the document was ﬁrst uploaded. Type: Timestamp DocumentVersionMetadata API Version 2016-05-01 208 Amazon WorkDocs Required: No CreatorId The ID of the creator. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. API Reference Pattern: [&\w+-.@]+ Required: No Id The ID of the version. Type: String Length Constraints: Minimum length of 1.
workdocs-api-038	workdocs-api.pdf	38	originally created. Type: Timestamp Required: No ContentModiﬁedTimestamp The timestamp when the content of the document was modiﬁed. Type: Timestamp Required: No ContentType The content type of the document. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No CreatedTimestamp The timestamp when the document was ﬁrst uploaded. Type: Timestamp DocumentVersionMetadata API Version 2016-05-01 208 Amazon WorkDocs Required: No CreatorId The ID of the creator. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. API Reference Pattern: [&\w+-.@]+ Required: No Id The ID of the version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No ModiﬁedTimestamp The timestamp when the document was last uploaded. Type: Timestamp Required: No Name The name of the version. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No Contents API Version 2016-05-01 209 Amazon WorkDocs Signature The signature of the document. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. API Reference Pattern: [&\w+-.@]+ Required: No Size The size of the document, in bytes. Type: Long Required: No Source The source of the document. Type: String to string map Valid Keys: ORIGINAL \| WITH_COMMENTS Value Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Status The status of the document. Type: String Valid Values: INITIALIZED \| ACTIVE Required: No Thumbnail The thumbnail of the document. Type: String to string map Contents API Version 2016-05-01 210 Amazon WorkDocs API Reference Valid Keys: SMALL \| SMALL_HQ \| LARGE Value Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 211 Amazon WorkDocs Filters Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Filters results based on entity metadata. Contents AncestorIds Filter based on resource’s path. Type: Array of strings Array Members: Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ContentCategories Filters by content category. Type: Array of strings Array Members: Maximum number of 9 items. Valid Values: IMAGE \| DOCUMENT \| PDF \| SPREADSHEET \| PRESENTATION \| AUDIO \| VIDEO \| SOURCE_CODE \| OTHER Required: No CreatedRange Filter based on resource’s creation timestamp. Type: DateRangeType object Filters API Version 2016-05-01 212 Amazon WorkDocs Required: No Labels API Reference Filter by labels using exact match. Type: Array of strings Array Members: Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ModiﬁedRange Filter based on resource’s modiﬁed timestamp. Type: DateRangeType object Required: No Principals Filter based on UserIds or GroupIds. Type: Array of SearchPrincipalType objects Array Members: Maximum number of 10 items. Required: No ResourceTypes Filters based on entity type. Type: Array of strings Array Members: Maximum number of 4 items. Valid Values: FOLDER \| DOCUMENT \| COMMENT \| DOCUMENT_VERSION Required: No SearchCollectionTypes Filter based on ﬁle groupings. Contents API Version 2016-05-01 213 API Reference Amazon WorkDocs Type: Array of strings Array Members: Maximum number of 2 items. Valid Values: OWNED \| SHARED_WITH_ME Required: No SizeRange Filter based on size (in bytes). Type: LongRangeType object Required: No TextLocales Filters by the locale of the content or comment. Type: Array of strings Array Members: Maximum number of 1 item. Valid Values: AR \| BG \| BN \| DA \| DE \| CS \| EL \| EN \| ES \| FA \| FI \| FR \| HI \| HU \| ID \| IT \| JA \| KO \| LT \| LV \| NL \| NO \| PT \| RO \| RU \| SV \| SW \| TH \| TR \| ZH \| DEFAULT Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 214 Amazon WorkDocs FolderMetadata Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes a folder. Contents CreatedTimestamp The time when the folder was created. Type: Timestamp Required: No CreatorId The ID of the creator. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Id The ID of the folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No FolderMetadata API Version 2016-05-01 215 API
workdocs-api-039	workdocs-api.pdf	39	2016-05-01 214 Amazon WorkDocs FolderMetadata Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes a folder. Contents CreatedTimestamp The time when the folder was created. Type: Timestamp Required: No CreatorId The ID of the creator. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Id The ID of the folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No FolderMetadata API Version 2016-05-01 215 API Reference Amazon WorkDocs Labels List of labels on the folder. Type: Array of strings Array Members: Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: [a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]* Required: No LatestVersionSize The size of the latest version of the folder metadata. Type: Long Required: No ModiﬁedTimestamp The time when the folder was updated. Type: Timestamp Required: No Name The name of the folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No ParentFolderId The ID of the parent folder. Type: String Contents API Version 2016-05-01 216 Amazon WorkDocs API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No ResourceState The resource state of the folder. Type: String Valid Values: ACTIVE \| RESTORING \| RECYCLING \| RECYCLED Required: No Signature The unique identiﬁer created from the subfolders and documents of the folder. Type: String Length Constraints: Minimum length of 0. Maximum length of 128. Pattern: [&\w+-.@]+ Required: No Size The size of the folder metadata. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 217 Amazon WorkDocs API Reference See Also API Version 2016-05-01 218 Amazon WorkDocs GroupMetadata Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the metadata of a user group. Contents Id The ID of the user group. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Name The name of the group. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GroupMetadata API Version 2016-05-01 219 Amazon WorkDocs API Reference See Also API Version 2016-05-01 220 Amazon WorkDocs LongRangeType Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Filter based on size (in bytes). Contents EndValue The size end range (in bytes). Type: Long Required: No StartValue The size start range (in bytes). Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LongRangeType API Version 2016-05-01 221 Amazon WorkDocs NotiﬁcationOptions Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Set of options which deﬁnes notiﬁcation preferences of given action. Contents EmailMessage Text value to be included in the email body. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No SendEmail Boolean value to indicate an email notiﬁcation should be sent to the recipients. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NotiﬁcationOptions API Version 2016-05-01 222 Amazon WorkDocs Participants Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the users or user groups. Contents Groups The list of user groups. Type: Array of GroupMetadata objects Required: No Users The list of users. Type: Array of UserMetadata objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Participants API Version 2016-05-01 223 Amazon WorkDocs PermissionInfo Important API Reference Notice: New customer sign-ups and account upgrades are
workdocs-api-040	workdocs-api.pdf	40	WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the users or user groups. Contents Groups The list of user groups. Type: Array of GroupMetadata objects Required: No Users The list of users. Type: Array of UserMetadata objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Participants API Version 2016-05-01 223 Amazon WorkDocs PermissionInfo Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the permissions. Contents Role The role of the user. Type: String Valid Values: VIEWER \| CONTRIBUTOR \| OWNER \| COOWNER Required: No Type The type of permissions. Type: String Valid Values: DIRECT \| INHERITED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PermissionInfo API Version 2016-05-01 224 Amazon WorkDocs API Reference See Also API Version 2016-05-01 225 Amazon WorkDocs Principal Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes a resource. Contents Id The ID of the resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Roles The permission information for the resource. Type: Array of PermissionInfo objects Required: No Type The type of resource. Type: String Valid Values: USER \| GROUP \| INVITE \| ANONYMOUS \| ORGANIZATION Required: No Principal API Version 2016-05-01 226 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 227 Amazon WorkDocs ResourceMetadata Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the metadata of a resource. Contents Id The ID of the resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Name The name of the resource. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No OriginalName The original name of the resource before a rename operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. ResourceMetadata API Version 2016-05-01 228 Amazon WorkDocs API Reference Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No Owner The owner of the resource. Type: UserMetadata object Required: No ParentId The parent ID of the resource before a rename operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Type The type of resource. Type: String Valid Values: FOLDER \| DOCUMENT Required: No VersionId The version ID of the resource. This is an optional ﬁeld and is ﬁlled for action on document version. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Contents API Version 2016-05-01 229 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 230 Amazon WorkDocs ResourcePath Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the path information of a resource. Contents Components The components of the resource path. Type: Array of ResourcePathComponent objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResourcePath API Version 2016-05-01 231 Amazon WorkDocs API Reference ResourcePathComponent Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the resource path. Contents Id The ID of the resource path. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Name The name of the resource path. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS
workdocs-api-041	workdocs-api.pdf	41	2016-05-01 231 Amazon WorkDocs API Reference ResourcePathComponent Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the resource path. Contents Id The ID of the resource path. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Name The name of the resource path. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: [\u0020-\u202D\u202F-\uFFFF]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ ResourcePathComponent API Version 2016-05-01 232 Amazon WorkDocs • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 233 Amazon WorkDocs ResponseItem Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. List of Documents, Folders, Comments, and Document Versions matching the query. Contents CommentMetadata The comment that matches the query. Type: CommentMetadata object Required: No DocumentMetadata The document that matches the query. Type: DocumentMetadata object Required: No DocumentVersionMetadata The document version that matches the metadata. Type: DocumentVersionMetadata object Required: No FolderMetadata The folder that matches the query. Type: FolderMetadata object Required: No ResponseItem API Version 2016-05-01 234 API Reference Amazon WorkDocs ResourceType The type of item being returned. Type: String Valid Values: DOCUMENT \| FOLDER \| COMMENT \| DOCUMENT_VERSION Required: No WebUrl The webUrl of the item being returned. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: [\u0020-\uFFFF]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 235 Amazon WorkDocs API Reference SearchPrincipalType Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Filter based on UserIds or GroupIds. Contents Id UserIds or GroupIds. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes Roles The Role of a User or Group. Type: Array of strings Array Members: Maximum number of 4 items. Valid Values: VIEWER \| CONTRIBUTOR \| OWNER \| COOWNER Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ SearchPrincipalType API Version 2016-05-01 236 Amazon WorkDocs • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 237 Amazon WorkDocs SearchSortResult Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. The result of the sort operation. Contents Field Sort search results based on this ﬁeld name. Type: String Valid Values: RELEVANCE \| NAME \| SIZE \| CREATED_TIMESTAMP \| MODIFIED_TIMESTAMP Required: No Order Sort direction. Type: String Valid Values: ASC \| DESC Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 SearchSortResult API Version 2016-05-01 238 Amazon WorkDocs • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 239 Amazon WorkDocs SharePrincipal Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the recipient type and ID, if available. Contents Id The ID of the recipient. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: Yes Role The role of the recipient. Type: String Valid Values: VIEWER \| CONTRIBUTOR \| OWNER \| COOWNER Required: Yes Type The type of the recipient. Type: String Valid Values: USER \| GROUP \| INVITE \| ANONYMOUS \| ORGANIZATION Required: Yes SharePrincipal API Version 2016-05-01 240 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 241 Amazon WorkDocs ShareResult Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the share results of a resource. Contents InviteePrincipalId The ID of the invited user. Type: String Length Constraints: Minimum length of 1. Maximum
workdocs-api-042	workdocs-api.pdf	42	See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 241 Amazon WorkDocs ShareResult Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the share results of a resource. Contents InviteePrincipalId The ID of the invited user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No PrincipalId The ID of the principal. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Role The role. Type: String Valid Values: VIEWER \| CONTRIBUTOR \| OWNER \| COOWNER ShareResult API Version 2016-05-01 242 Amazon WorkDocs Required: No ShareId The ID of the resource that was shared. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. API Reference Pattern: [\w+-.@]+ Required: No Status The status. Type: String Valid Values: SUCCESS \| FAILURE Required: No StatusMessage The status message. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 243 Amazon WorkDocs StorageRuleType Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the storage for a user. Contents StorageAllocatedInBytes The amount of storage allocated, in bytes. Type: Long Valid Range: Minimum value of 0. Required: No StorageType The type of storage. Type: String Valid Values: UNLIMITED \| QUOTA Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 StorageRuleType API Version 2016-05-01 244 Amazon WorkDocs API Reference See Also API Version 2016-05-01 245 Amazon WorkDocs Subscription Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes a subscription. Contents EndPoint The endpoint of the subscription. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Protocol The protocol of the subscription. Type: String Valid Values: HTTPS \| SQS Required: No SubscriptionId The ID of the subscription. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Subscription API Version 2016-05-01 246 Amazon WorkDocs See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 247 Amazon WorkDocs UploadMetadata Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the upload. Contents SignedHeaders The signed headers. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 256. Key Pattern: [\w-]+ Value Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No UploadUrl The URL of the upload. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ UploadMetadata API Version 2016-05-01 248 Amazon WorkDocs • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2016-05-01 249 Amazon WorkDocs User Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes a user. Contents CreatedTimestamp The time when the user was created. Type: Timestamp Required: No EmailAddress The email address of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,} Required: No GivenName The given name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No The ID of the user. Id User API Version 2016-05-01 250 Amazon WorkDocs Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Locale The locale of the user. Type: String Valid Values: en \| fr \| ko \| de
workdocs-api-043	workdocs-api.pdf	43	the user was created. Type: Timestamp Required: No EmailAddress The email address of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,} Required: No GivenName The given name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No The ID of the user. Id User API Version 2016-05-01 250 Amazon WorkDocs Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No Locale The locale of the user. Type: String Valid Values: en \| fr \| ko \| de \| es \| ja \| ru \| zh_CN \| zh_TW \| pt_BR \| default Required: No ModiﬁedTimestamp The time when the user was modiﬁed. Type: Timestamp Required: No OrganizationId The ID of the organization. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ Required: No RecycleBinFolderId The ID of the recycle bin folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Contents API Version 2016-05-01 251 API Reference Amazon WorkDocs Pattern: [\w+-.@]+ Required: No RootFolderId The ID of the root folder. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [\w+-.@]+ Required: No Status The status of the user. Type: String Valid Values: ACTIVE \| INACTIVE \| PENDING Required: No Storage The storage for the user. Type: UserStorageMetadata object Required: No Surname The surname of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No TimeZoneId The time zone ID of the user. Contents API Version 2016-05-01 252 Amazon WorkDocs Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Required: No Type The type of user. Type: String Valid Values: USER \| ADMIN \| POWERUSER \| MINIMALUSER \| WORKSPACESUSER Required: No Username The login name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w\-+.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z]+)? Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 253 Amazon WorkDocs UserMetadata Important API Reference Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the metadata of the user. Contents EmailAddress The email address of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,} Required: No GivenName The given name of the user before a rename operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Id The ID of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [&\w+-.@]+ UserMetadata API Version 2016-05-01 254 Amazon WorkDocs Required: No Surname The surname of the user. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Username The name of the user. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [\w\-+.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z]+)? Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2016-05-01 255 Amazon WorkDocs API Reference UserStorageMetadata Important Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. Describes the storage for a user. Contents StorageRule The storage for a user. Type: StorageRuleType object Required: No StorageUtilizedInBytes The amount of storage used, in bytes. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UserStorageMetadata API Version 2016-05-01 256 Amazon WorkDocs API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential
workdocs-api-044	workdocs-api.pdf	44	string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2016-05-01 257 Amazon WorkDocs API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2016-05-01 258 Amazon WorkDocs Type: string Required: Conditional X-Amz-SignedHeaders API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2016-05-01 259 Amazon WorkDocs API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2016-05-01 260 Amazon WorkDocs HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2016-05-01 261 Amazon WorkDocs UnknownOperationException API Reference The action or operation
workdocs-api-045	workdocs-api.pdf	45	or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2016-05-01 261 Amazon WorkDocs UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2016-05-01 262
workdocs-dg-001	workdocs-dg.pdf	1	Developer Guide Amazon WorkDocs Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon WorkDocs Developer Guide Amazon WorkDocs: Developer Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon WorkDocs Table of Contents Developer Guide ......................................................................................................................................................... iv What is Amazon WorkDocs? ........................................................................................................... 1 Accessing Amazon WorkDocs ..................................................................................................................... 1 Pricing ............................................................................................................................................................. 1 Resources ........................................................................................................................................................ 1 Getting started ................................................................................................................................ 3 Connect to Amazon WorkDocs with IAM user credentials ................................................................... 3 Connecting to Amazon WorkDocs by assuming a role ......................................................................... 5 Upload a document ..................................................................................................................................... 8 Download a document ................................................................................................................................ 9 Setting up notiﬁcations ............................................................................................................................ 10 Creating a user ........................................................................................................................................... 13 Granting users permissions to a resource ............................................................................................. 14 Authentication and access control for administrative applications ........................................... 15 Granting developers permissions to the Amazon WorkDocs API ..................................................... 15 Granting third-party developers permission to the Amazon WorkDocs APIs ................................ 16 Granting users permission to assume an IAM role .............................................................................. 18 Restricting access to a speciﬁc Amazon WorkDocs instance ............................................................. 18 Authentication and access control for user applications ............................................................ 20 Granting permissions to call the Amazon WorkDocs APIs ................................................................. 20 Using folder IDs in API calls .................................................................................................................... 22 Create an application ................................................................................................................................ 23 Application scopes ..................................................................................................................................... 23 Authorization ............................................................................................................................................... 24 Invoking Amazon WorkDocs APIs ........................................................................................................... 25 Amazon WorkDocs Content Manager ........................................................................................... 27 Constructing Amazon WorkDocs Content Manager ............................................................................ 27 Downloading a document ........................................................................................................................ 28 Uploading a document ............................................................................................................................. 29 iii Amazon WorkDocs Developer Guide Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. iv Amazon WorkDocs Developer Guide What is Amazon WorkDocs? Amazon WorkDocs is a document storage, collaboration, and sharing system. Amazon WorkDocs is fully managed, secure, and enterprise scale. It provides strong administrative controls, plus feedback capabilities that help improve user productivity. Files are stored in the cloud, safely and securely. Your user's ﬁles are only visible to them, and their designated contributors and viewers. Other members of your organization do not have access to other user's ﬁles unless they are speciﬁcally granted access. Users can share their ﬁles with other members of your organization for collaboration or review. The Amazon WorkDocs client applications can be used to view many diﬀerent types of ﬁles, depending on the Internet media type of the ﬁle. Amazon WorkDocs supports all common document and image formats, and support for additional media types is constantly being added. For more information, see Amazon WorkDocs. Accessing Amazon WorkDocs End users use the client applications to access their ﬁles. Non-administrative users never need to use the Amazon WorkDocs console or the administration dashboard. Amazon WorkDocs oﬀers several diﬀerent client applications and utilities: • A web application used for document management and reviewing. • Native apps for mobile devices used for document review. • Amazon WorkDocs Drive used to synchronize a folder on your Mac or Windows desktop with your Amazon WorkDocs ﬁles. Pricing With Amazon WorkDocs, there are no upfront fees or commitments. You pay only for active user accounts, and the storage you use. For more information, go to Pricing. Resources The following related resources can help you as you work with this service. Accessing Amazon WorkDocs 1 Amazon WorkDocs Developer Guide • Classes & Workshops – Links to role-based and specialty courses, in addition to self-paced labs to help sharpen your AWS skills and gain practical experience. • AWS Developer Center – Explore tutorials, download tools, and learn about AWS developer events. • AWS Developer Tools – Links to developer tools, SDKs, IDE toolkits, and command line tools for developing and managing AWS applications. • Getting Started Resource Center – Learn how to set up your AWS account, join the AWS community, and launch your ﬁrst application. • Hands-On Tutorials – Follow step-by-step tutorials to launch your ﬁrst application on AWS. • AWS Whitepapers – Links to a comprehensive list of technical AWS whitepapers, covering topics such as architecture, security, and economics and authored by AWS Solutions Architects or other technical experts. • AWS Support Center – The hub for creating and managing your AWS Support cases. Also includes links to other helpful resources, such as forums, technical FAQs, service health status, and AWS Trusted Advisor. • Support – The primary webpage for information about Support, a one-on-one, fast-response support channel to help you build and run applications in the cloud. • Contact Us
workdocs-dg-002	workdocs-dg.pdf	2	to launch your ﬁrst application on AWS. • AWS Whitepapers – Links to a comprehensive list of technical AWS whitepapers, covering topics such as architecture, security, and economics and authored by AWS Solutions Architects or other technical experts. • AWS Support Center – The hub for creating and managing your AWS Support cases. Also includes links to other helpful resources, such as forums, technical FAQs, service health status, and AWS Trusted Advisor. • Support – The primary webpage for information about Support, a one-on-one, fast-response support channel to help you build and run applications in the cloud. • Contact Us – A central contact point for inquiries concerning AWS billing, account, events, abuse, and other issues. • AWS Site Terms – Detailed information about our copyright and trademark; your account, license, and site access; and other topics. Resources 2 Amazon WorkDocs Developer Guide Getting started The following code snippets can help you get started using the Amazon WorkDocs SDK. Note For greater security, create federated users instead of IAM users whenever possible. Examples • Connect to Amazon WorkDocs with IAM user credentials and query for users • Connecting to Amazon WorkDocs by assuming a role • Upload a document • Download a document • Setting up notiﬁcations • Creating a user • Granting users permissions to a resource Connect to Amazon WorkDocs with IAM user credentials and query for users The following code shows how to use an IAM user's API credentials to make API calls. In this case the API user and the Amazon WorkDocs site belong to the same AWS account. Note For greater security, create federated users instead of IAM users whenever possible. Ensure that the IAM user has been granted Amazon WorkDocs API access through an appropriate IAM policy. The code sample uses the DescribeUsers API to search for users, and obtain metadata for users. User metadata provides details such as ﬁrst name, last name, user ID and root Folder ID. Root Connect to Amazon WorkDocs with IAM user credentials 3 Amazon WorkDocs Developer Guide folder ID is particularly helpful if you want to perform any content upload or download operations on behalf of the user. The code requires that you obtain an Amazon WorkDocs Organization ID. Follow these steps to obtain a Amazon WorkDocs organization ID from the AWS console: To get an organization ID 1. In the AWS Directory Service console navigation pane, choose Directories. 2. Note the Directory ID value that corresponds to your Amazon WorkDocs site. That is the Organization ID for the site. The following example shows how to use IAM credentials to make API calls. import java.util.ArrayList; import java.util.List; import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.AWSStaticCredentialsProvider; import com.amazonaws.auth.BasicAWSCredentials; import com.amazonaws.regions.Regions; import com.amazonaws.services.workdocs.AmazonWorkDocs; import com.amazonaws.services.workdocs.AmazonWorkDocsClient; import com.amazonaws.services.workdocs.model.DescribeUsersRequest; import com.amazonaws.services.workdocs.model.DescribeUsersResult; import com.amazonaws.services.workdocs.model.User; public class GetUserDemo { public static void main(String[] args) throws Exception { AWSCredentials longTermCredentials = new BasicAWSCredentials("accessKey", "secretKey"); AWSStaticCredentialsProvider staticCredentialProvider = new AWSStaticCredentialsProvider(longTermCredentials); AmazonWorkDocs workDocs = AmazonWorkDocsClient.builder().withCredentials(staticCredentialProvider) .withRegion(Regions.US_WEST_2).build(); List<User> wdUsers = new ArrayList<>(); DescribeUsersRequest request = new DescribeUsersRequest(); Connect to Amazon WorkDocs with IAM user credentials 4 Amazon WorkDocs Developer Guide // The OrganizationId used here is an example and it should be replaced // with the OrganizationId of your WorkDocs site. request.setOrganizationId("d-123456789c"); request.setQuery("joe"); String marker = null; do { request.setMarker(marker); DescribeUsersResult result = workDocs.describeUsers(request); wdUsers.addAll(result.getUsers()); marker = result.getMarker(); } while (marker != null); System.out.println("List of users matching the query string: joe "); for (User wdUser : wdUsers) { System.out.printf("Firstname:%s \| Lastname:%s \| Email:%s \| root-folder-id:%s\n", wdUser.getGivenName(), wdUser.getSurname(), wdUser.getEmailAddress(), wdUser.getRootFolderId()); } } } Connecting to Amazon WorkDocs by assuming a role This example uses the AWS Java SDK to assume a role and use the role's temporary security credentials to access Amazon WorkDocs. The code sample uses the DescribeFolderContents API to list the items in a user's folder. import java.util.ArrayList; import java.util.List; import com.amazonaws.auth.AWSCredentials; import com.amazonaws.auth.AWSStaticCredentialsProvider; import com.amazonaws.auth.BasicAWSCredentials; import com.amazonaws.auth.BasicSessionCredentials; import com.amazonaws.regions.Regions; import com.amazonaws.services.securitytoken.AWSSecurityTokenService; import com.amazonaws.services.securitytoken.AWSSecurityTokenServiceClientBuilder; import com.amazonaws.services.securitytoken.model.AssumeRoleRequest; import com.amazonaws.services.securitytoken.model.AssumeRoleResult; Connecting to Amazon WorkDocs by assuming a role 5 Amazon WorkDocs Developer Guide import com.amazonaws.services.workdocs.AmazonWorkDocs; import com.amazonaws.services.workdocs.AmazonWorkDocsClient; import com.amazonaws.services.workdocs.model.DescribeFolderContentsRequest; import com.amazonaws.services.workdocs.model.DescribeFolderContentsResult; import com.amazonaws.services.workdocs.model.DocumentMetadata; import com.amazonaws.services.workdocs.model.FolderMetadata; public class AssumeRoleDemo { private static final String DEMO_ROLE_ARN = "arn:aws:iam::111122223333:role/workdocs- readonly-role"; private static AmazonWorkDocs workDocs; public static void main(String[] args) throws Exception { AWSCredentials longTermCredentials = new BasicAWSCredentials("accessKey", "secretKey"); // Use developer’s long-term credentials to call the AWS Security Token Service (STS) // AssumeRole API, specifying the ARN for the role workdocs-readonly-role in // 3rd party AWS account. AWSSecurityTokenService stsClient = AWSSecurityTokenServiceClientBuilder.standard() .withCredentials(new AWSStaticCredentialsProvider(longTermCredentials)) .withRegion(Regions.DEFAULT_REGION.getName()).build();; // If you are accessing a 3rd party account, set ExternalId // on assumeRequest using the withExternalId() function. AssumeRoleRequest assumeRequest = new AssumeRoleRequest().withRoleArn(DEMO_ROLE_ARN).withDurationSeconds(3600) .withRoleSessionName("demo"); AssumeRoleResult assumeResult = stsClient.assumeRole(assumeRequest); // AssumeRole returns temporary security credentials for the // workdocs-readonly-role BasicSessionCredentials temporaryCredentials = new BasicSessionCredentials(assumeResult.getCredentials().getAccessKeyId(), assumeResult .getCredentials().getSecretAccessKey(), assumeResult.getCredentials().getSessionToken()); Connecting to Amazon WorkDocs by assuming a role 6 Amazon WorkDocs Developer Guide // Build WorkDocs
workdocs-dg-003	workdocs-dg.pdf	3	BasicAWSCredentials("accessKey", "secretKey"); // Use developer’s long-term credentials to call the AWS Security Token Service (STS) // AssumeRole API, specifying the ARN for the role workdocs-readonly-role in // 3rd party AWS account. AWSSecurityTokenService stsClient = AWSSecurityTokenServiceClientBuilder.standard() .withCredentials(new AWSStaticCredentialsProvider(longTermCredentials)) .withRegion(Regions.DEFAULT_REGION.getName()).build();; // If you are accessing a 3rd party account, set ExternalId // on assumeRequest using the withExternalId() function. AssumeRoleRequest assumeRequest = new AssumeRoleRequest().withRoleArn(DEMO_ROLE_ARN).withDurationSeconds(3600) .withRoleSessionName("demo"); AssumeRoleResult assumeResult = stsClient.assumeRole(assumeRequest); // AssumeRole returns temporary security credentials for the // workdocs-readonly-role BasicSessionCredentials temporaryCredentials = new BasicSessionCredentials(assumeResult.getCredentials().getAccessKeyId(), assumeResult .getCredentials().getSecretAccessKey(), assumeResult.getCredentials().getSessionToken()); Connecting to Amazon WorkDocs by assuming a role 6 Amazon WorkDocs Developer Guide // Build WorkDocs client using the temporary credentials. workDocs = AmazonWorkDocsClient.builder() .withCredentials(new AWSStaticCredentialsProvider(temporaryCredentials)) .withRegion(Regions.US_WEST_2).build(); // Invoke WorkDocs service calls using the temporary security credentials // obtained for workdocs-readonly-role. In this case a call has been made // to get metadata of Folders and Documents present in a user’s root folder. describeFolder("root-folder-id"); } private static void describeFolder(String folderId) { DescribeFolderContentsRequest request = new DescribeFolderContentsRequest(); request.setFolderId(folderId); request.setLimit(2); List<DocumentMetadata> documents = new ArrayList<>(); List<FolderMetadata> folders = new ArrayList<>(); String marker = null; do { request.setMarker(marker); DescribeFolderContentsResult result = workDocs.describeFolderContents(request); documents.addAll(result.getDocuments()); folders.addAll(result.getFolders()); marker = result.getMarker(); } while (marker != null); for (FolderMetadata folder : folders) System.out.println("Folder:" + folder.getName()); for (DocumentMetadata document : documents) System.out.println("Document:" + document.getLatestVersionMetadata().getName()); } } Connecting to Amazon WorkDocs by assuming a role 7 Amazon WorkDocs Developer Guide Upload a document Note You must be a software developer to complete the steps in this section. For information about using Amazon WorkDocs to upload ﬁles, see Uploading ﬁles in the Amazon WorkDocs User Guide. Use the following procedure to upload a document to Amazon WorkDocs. To upload a document 1. Create an instance of AmazonWorkDocsClient as follows: If you use IAM user credentials, refer to Connect to Amazon WorkDocs with IAM user credentials and query for users. If you assume an IAM role, refer to Connecting to Amazon WorkDocs by assuming a role for more information. Note For greater security, create federated users instead of IAM users whenever possible. AWSCredentials longTermCredentials = new BasicAWSCredentials("accessKey", "secretKey"); AWSStaticCredentialsProvider staticCredentialProvider = new AWSStaticCredentialsProvider(longTermCredentials); // Use the region specific to your WorkDocs site. AmazonWorkDocs amazonWorkDocsClient = AmazonWorkDocsClient.builder().withCredentials(staticCredentialProvider) .withRegion(Regions.US_WEST_2).build(); 2. Get the signed URL for the upload as follows: InitiateDocumentVersionUploadRequest request = new InitiateDocumentVersionUploadRequest(); request.setParentFolderId("parent-folder-id"); request.setName("my-document-name"); Upload a document 8 Amazon WorkDocs Developer Guide request.setContentType("application/octet-stream"); InitiateDocumentVersionUploadResult result = amazonWorkDocsClient.initiateDocumentVersionUpload(request); UploadMetadata uploadMetadata = result.getUploadMetadata(); String documentId = result.getMetadata().getId(); String documentVersionId = result.getMetadata().getLatestVersionMetadata().getId(); String uploadUrl = uploadMetadata.getUploadUrl(); 3. Upload the document using the signed URL as follows: URL url = new URL(uploadUrl); HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setDoOutput(true); connection.setRequestMethod("PUT"); // Content-Type supplied here should match with the Content-Type set // in the InitiateDocumentVersionUpload request. connection.setRequestProperty("Content-Type","application/octet-stream"); connection.setRequestProperty("x-amz-server-side-encryption", "AES256"); File file = new File("/path/to/file.txt"); FileInputStream fileInputStream = new FileInputStream(file); OutputStream outputStream = connection.getOutputStream(); com.amazonaws.util.IOUtils.copy(fileInputStream, outputStream); connection.getResponseCode(); 4. Complete the upload process by changing the document status to ACTIVE as follows: UpdateDocumentVersionRequest request = new UpdateDocumentVersionRequest(); request.setDocumentId("document-id"); request.setVersionId("document-version-id"); request.setVersionStatus(DocumentVersionStatus.ACTIVE); amazonWorkDocsClient.updateDocumentVersion(request); Download a document Note You must be a software developer to complete the steps in this section. For information about using Amazon WorkDocs to download ﬁles, see Downloading ﬁles in the Amazon WorkDocs User Guide. Download a document 9 Amazon WorkDocs Developer Guide To download a document from Amazon WorkDocs, get a URL for the download as follows, and then use the API actions provided by your development platform to download the ﬁle using the URL. GetDocumentVersionRequest request = new GetDocumentVersionRequest(); request.setDocumentId("document-id"); request.setVersionId("document-version-id"); request.setFields("SOURCE"); GetDocumentVersionResult result = amazonWorkDocsClient.getDocumentVersion(request); String downloadUrl = result.getMetadata().getSource().get(DocumentSourceType.ORIGINAL.name()); Setting up notiﬁcations You follow this process to set up notiﬁcations: 1. Set IAM User or Role permissions to allow caller access to notiﬁcation subscription management APIs. 2. Call the notiﬁcation subscription APIs to enable or disable publishing of SNS messages to your endpoint. Note For greater security, create federated users instead of IAM users whenever possible. To set IAM user permissions • Use the IAM console to set the following permissions for the user: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "workdocs:CreateNotificationSubscription", "workdocs:DeleteNotificationSubscription", "workdocs:DescribeNotificationSubscriptions" Setting up notiﬁcations 10 Amazon WorkDocs Developer Guide ], "Resource": "*" } ] } To enable notiﬁcations Enabling notiﬁcations allows you to call CreateNotiﬁcationSubscription after you subscribe to notiﬁcations. 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. On the Manage Your WorkDocs Sites page, select the desired directory and choose Actions and then Manage Notiﬁcations. 3. On the Manage Notiﬁcations page, choose Enable Notiﬁcations. 4. Enter the ARN for the user or role you want to allow to receive notiﬁcations from your Amazon WorkDocs site. For information about enabling Amazon WorkDocs to use notiﬁcations, see Using the Amazon WorkDocs API with the AWS SDK for Python and AWS Lambda. Once you enable notiﬁcations, you and your user can subscribe to them. To subscribe to WorkDocs notiﬁcations 1. Prepare your endpoint to process Amazon SNS
workdocs-dg-004	workdocs-dg.pdf	4	at https://console.aws.amazon.com/zocalo/. 2. On the Manage Your WorkDocs Sites page, select the desired directory and choose Actions and then Manage Notiﬁcations. 3. On the Manage Notiﬁcations page, choose Enable Notiﬁcations. 4. Enter the ARN for the user or role you want to allow to receive notiﬁcations from your Amazon WorkDocs site. For information about enabling Amazon WorkDocs to use notiﬁcations, see Using the Amazon WorkDocs API with the AWS SDK for Python and AWS Lambda. Once you enable notiﬁcations, you and your user can subscribe to them. To subscribe to WorkDocs notiﬁcations 1. Prepare your endpoint to process Amazon SNS messages. For more information, see Fanout to HTTP/S endpoints in the Amazon Simple Notiﬁcation Service Developer Guide. Important SNS sends a conﬁrmation message to your conﬁgured endpoint. You must conﬁrm this message in order to receive notiﬁcations. Also, if you require FIPS 140-2 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-2. 2. Do the following: • Get an organization ID Setting up notiﬁcations 11 Amazon WorkDocs Developer Guide 1. In the AWS Directory Service console navigation pane, select Directories. 2. The Directory ID corresponding to your Amazon WorkDocs site also serves as the Organization ID for that site. • Create the subscription request as follows: CreateNotificationSubscriptionRequest request = new CreateNotificationSubscriptionRequest(); request.setOrganizationId("d-1234567890"); request.setProtocol(SubscriptionProtocolType.Https); request.setEndpoint("https://my-webhook-service.com/webhook"); request.setSubscriptionType(SubscriptionType.ALL); CreateNotificationSubscriptionResult result = amazonWorkDocsClient.createNotificationSubscription(request); System.out.println("WorkDocs notifications subscription-id: " result.getSubscription().getSubscriptionId()); SNS Notiﬁcations The message includes the following information: • organizationId — The ID of the organization. • parentEntityType — The type of the parent (Document \| DocumentVersion \| Folder). • parentEntityId — The ID of the parent. • entityType — The type of the entity (Document \| DocumentVersion \| Folder). • entityId — The ID of the entity. • action — The action, which can be one of the following values: • delete_document • move_document • recycle_document • rename_document • revoke_share_document • share_document • upload_document_version Setting up notiﬁcations 12 Amazon WorkDocs To disable notiﬁcations Developer Guide 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. On the Manage Your WorkDocs Sites page, select the desired directory and choose Actions and then Manage Notiﬁcations. 3. On the Manage Notiﬁcations page, select the ARN that you wish to disable notiﬁcations for and choose Disable Notiﬁcations. Creating a user The following example show to create a user in Amazon WorkDocs. Note This is not a valid operation for a Connected AD conﬁguration. To create a user in the Connected AD conﬁguration, the user must already be present in the enterprise directory. Then, you must make a call to the ActivateUser API to activate the user in Amazon WorkDocs. The following example demonstrates how to create a user with a storage quota of 1 gigabyte. CreateUserRequest request = new CreateUserRequest(); request.setGivenName("GivenName"); request.setOrganizationId("d-12345678c4"); // Passwords should: // Be between 8 and 64 characters // Contain three of the four below: // A Lowercase Character // An Uppercase Character // A Number // A Special Character request.setPassword("Badpa$$w0rd"); request.setSurname("surname"); request.setUsername("UserName"); StorageRuleType storageRule = new StorageRuleType(); storageRule.setStorageType(StorageType.QUOTA); storageRule.setStorageAllocatedInBytes(new Long(1048576l)); request.setStorageRule(storageRule); Creating a user 13 Amazon WorkDocs Developer Guide CreateUserResult result = workDocsClient.createUser(request); Follow these steps to obtain a Amazon WorkDocs organization ID from the AWS console: To get an organization ID 1. In the AWS Directory Service console navigation pane, choose Directories. 2. Note the Directory ID value that corresponds to your Amazon WorkDocs site. That is the Organization ID for the site. Granting users permissions to a resource The following example shows how to use the AddResourcePermissions API to grant CONTRIBUTOR permissions to a USER on a resource. You can also use the API to give permissions to a user or group on a folder or document. AddResourcePermissionsRequest request = new AddResourcePermissionsRequest(); request.setResourceId("resource-id"); Collection<SharePrincipal> principals = new ArrayList<>();; SharePrincipal principal = new SharePrincipal(); principal.setId("user-id"); principal.setType(PrincipalType.USER); principal.setRole(RoleType.CONTRIBUTOR); principals.add(principal); request.setPrincipals(principals); AddResourcePermissionsResult result = workDocsClient.addResourcePermissions(request); Granting users permissions to a resource 14 Amazon WorkDocs Developer Guide Authentication and access control for administrative applications Amazon WorkDocs administrative APIs are authenticated and authorized through IAM policies. IAM administrators can create an IAM policy and attach it to an IAM role or user that can be used by the developer to access the API. The following are provided as examples: Tasks • Granting developers permissions to the Amazon WorkDocs API • Granting third-party developers permission to the Amazon WorkDocs APIs • Granting users permission to assume an IAM role • Restricting access to a speciﬁc Amazon WorkDocs instance Granting developers permissions to the Amazon WorkDocs API Note For greater security, create federated users instead of IAM users whenever possible. If you are an IAM administrator, you can grant Amazon WorkDocs API access to an IAM user from the same AWS account. To do this, create
workdocs-dg-005	workdocs-dg.pdf	5	be used by the developer to access the API. The following are provided as examples: Tasks • Granting developers permissions to the Amazon WorkDocs API • Granting third-party developers permission to the Amazon WorkDocs APIs • Granting users permission to assume an IAM role • Restricting access to a speciﬁc Amazon WorkDocs instance Granting developers permissions to the Amazon WorkDocs API Note For greater security, create federated users instead of IAM users whenever possible. If you are an IAM administrator, you can grant Amazon WorkDocs API access to an IAM user from the same AWS account. To do this, create a Amazon WorkDocs API permission policy and attach it to the IAM user. The following API policy grants read-only permission to the various Describe APIs. { "Version": "2012-10-17", "Statement": [ { "Sid": "WorkDocsAPIReadOnly", "Effect": "Allow", "Action": [ "workdocs:Get", "workdocs:Describe" ], Granting developers permissions to the Amazon WorkDocs API 15 Amazon WorkDocs "Resource": [ "*" ] } ] } Developer Guide Granting third-party developers permission to the Amazon WorkDocs APIs You can grant access to third-party developers, or to users who are using a diﬀerent AWS account. To do this, create an IAM role, and attach Amazon WorkDocs API allow policies. This form of access is required in the following scenarios: • Developer belongs to the same organization but the developer’s AWS account is diﬀerent from the Amazon WorkDocs AWS account. • When an enterprise would like to grant Amazon WorkDocs API access to third-party application developers. In both of these scenarios, there are two AWS accounts involved, a developer’s AWS account and a diﬀerent account hosting a Amazon WorkDocs site. The developer will need to provide the following information so the account administrator can create the IAM role: • Your AWS account ID • A unique External ID that your customer will use to identify you. For more information, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party. • A list of Amazon WorkDocs APIs your application needs access to. IAM based policy control provides granular control, the ability to deﬁne allow or deny policies at the individual API level. For the list of Amazon WorkDocs APIs, see Amazon WorkDocs API Reference. The following procedure describes steps involved in conﬁguring IAM for cross-account access. To conﬁgure IAM for cross-account access 1. Create a Amazon WorkDocs API permission policy, call it WorkDocsAPIReadOnly policy. Granting third-party developers permission to the Amazon WorkDocs APIs 16 Amazon WorkDocs Developer Guide 2. Create a new role in the IAM console of the AWS account hosting the Amazon WorkDocs site: a. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. b. c. In the navigation pane of the console, click Roles and then click Create New Role. For Role name, type a role name to help identify the purpose of this role, for example workdocs_app_role. Role names must be unique within your AWS account. After you enter the name, click Next Step. d. On the Select Role Type page, select the Role for Cross-Account Access section, and then select the type of role that you want to create: • Select Provide access between AWS accounts you own if you are the administrator of both the user account and the resource account, or both accounts belong to the same company. This is also the option to select when the users, role, and resource to be accessed are all in the same account. • Select Provide access between your AWS account and a third-party AWS account if you are the administrator of the account that owns the Amazon WorkDocs site and you want to grant permissions to users from an Application developer account. This option requires you to specify an external ID (which the third party must provide to you) to provide additional control over the circumstances in which the third party can use the role to access your resources. For more information, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party. e. On the next page, specify the AWS account ID to which you want to grant access to your resources and also enter External ID in case of third-party access. f. Click Next Step to attach a policy. 3. On the Attach Policy page, search for the Amazon WorkDocs API permission policy that was created earlier and select the box next to the policy and click Next Step. 4. Review the details, copy the role ARN for future reference and click Create Role to complete the creation of the role. 5. Share the role ARN with the developer. The following is an example of the role ARN: arn:aws:iam::AWS-ACCOUNT-ID:role/workdocs_app_role Granting third-party developers permission to the Amazon WorkDocs APIs 17 Amazon WorkDocs Developer Guide
workdocs-dg-006	workdocs-dg.pdf	6	enter External ID in case of third-party access. f. Click Next Step to attach a policy. 3. On the Attach Policy page, search for the Amazon WorkDocs API permission policy that was created earlier and select the box next to the policy and click Next Step. 4. Review the details, copy the role ARN for future reference and click Create Role to complete the creation of the role. 5. Share the role ARN with the developer. The following is an example of the role ARN: arn:aws:iam::AWS-ACCOUNT-ID:role/workdocs_app_role Granting third-party developers permission to the Amazon WorkDocs APIs 17 Amazon WorkDocs Developer Guide Granting users permission to assume an IAM role A developer with an administrative AWS account can allow a user to assume an IAM role. To do that, you create a new policy and attach it to that user. The policy must include a statement with the Allow eﬀect on the sts:AssumeRole action, plus the Amazon Resource Name (ARN) of the role in a Resource element, as shown in the following example. Users that get the policy, either through group membership or direct attachment, can switch to the speciﬁed role. { "Version": "2012-10-17", "Statement": { "Effect": "Allow", "Action": "sts:AssumeRole", "Resource": "arn:aws:iam::<aws_account_id>:role/workdocs_app_role" } } Restricting access to a speciﬁc Amazon WorkDocs instance If you have multiple Amazon WorkDocs sites on an AWS account and you want to grant API access to a speciﬁc site, you can deﬁne a Condition element. The Condition element lets you specify conditions for when a policy is in eﬀect. The following example shows a condition element: "Condition": { "StringEquals": { "Resource.OrganizationId": "d-123456789c5" } } With the above condition in place in a policy, users can only access the Amazon WorkDocs instance with the ID of d-123456789c5. Amazon WorkDocs Instance ID is sometimes referred as Organization ID or Directory ID. For more information, see Restricting access to a speciﬁc Amazon WorkDocs instance. Follow these steps to obtain a Amazon WorkDocs organization ID from the AWS console: Granting users permission to assume an IAM role 18 Amazon WorkDocs To get an organization ID Developer Guide 1. In the AWS Directory Service console navigation pane, choose Directories. 2. Note the Directory ID value that corresponds to your Amazon WorkDocs site. That is the Organization ID for the site. Restricting access to a speciﬁc Amazon WorkDocs instance 19 Amazon WorkDocs Developer Guide Authentication and access control for user applications Amazon WorkDocs user level applications are registered and managed through the Amazon WorkDocs console. Developers should register their applications on the My Applications page on the Amazon WorkDocs console which will provide unique IDs for each application. During registration, developers should specify redirect URIs where they will receive access tokens as well as application scopes. Currently, applications can only access Amazon WorkDocs sites within the same AWS account where they are registered. Contents • Granting permissions to call the Amazon WorkDocs APIs • Using folder IDs in API calls • Create an application • Application scopes • Authorization • Invoking Amazon WorkDocs APIs Granting permissions to call the Amazon WorkDocs APIs Command line interface users must have full permissions to Amazon WorkDocs and AWS Directory Service. Without the permissions, any API calls return UnauthorizedResourceAccessException messages. The following policy grants full permissions. { "Version": "2012-10-17", "Statement": [ { "Action": [ "workdocs:", "ds:", "ec2:CreateVpc", "ec2:CreateSubnet", "ec2:CreateNetworkInterface", "ec2:CreateTags", "ec2:CreateSecurityGroup", Granting permissions to call the Amazon WorkDocs APIs 20 Amazon WorkDocs Developer Guide "ec2:DescribeVpcs", "ec2:DescribeSubnets", "ec2:DescribeNetworkInterfaces", "ec2:DescribeAvailabilityZones", "ec2:AuthorizeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupIngress", "ec2:DeleteSecurityGroup", "ec2:DeleteNetworkInterface", "ec2:RevokeSecurityGroupEgress", "ec2:RevokeSecurityGroupIngress" ], "Effect": "Allow", "Resource": "" } ] } If you want to grant read-only permissions, use this policy. { "Version": "2012-10-17", "Statement": [ { "Action": [ "workdocs:Describe", "ds:DescribeDirectories", "ec2:DescribeVpcs", "ec2:DescribeSubnets" ], "Effect": "Allow", "Resource": "*" } ] } In the policy, the ﬁrst action grants access to all the Amazon WorkDocs Describe operations. The DescribeDirectories action obtains information about your AWS Directory Service directories. The Amazon EC2 operations enable Amazon WorkDocs to obtain a list of your VPCs and subnets. Granting permissions to call the Amazon WorkDocs APIs 21 Amazon WorkDocs Developer Guide Using folder IDs in API calls Whenever an API call accesses a folder, you must use the folder ID, not the folder name. For example, if you pass client.get_folder(FolderId='MyDocs'), the API call returns an UnauthorizedResourceAccessException message and the following 404 message. client.get_folder(FolderId='MyDocs') Traceback (most recent call last): File "<stdin>", line 1, in <module> File "C:\Users\user-name\AppData\Local\Programs\Python\Python36-32\lib\site-packages \botocore\client.py", line 253, in _api_call return self._make_api_call(operation_name, kwargs) File "C:\Users\user-name\AppData\Local\Programs\Python\Python36-32\lib\site-packages \botocore\client.py", line 557, in _make_api_call raise error_class(parsed_response, operation_name) botocore.errorfactory.UnauthorizedResourceAccessException: An error occurred (UnauthorizedResourceAccessException) when calling the GetFolder operation: Principal [arn:aws:iam::395162986870:user/Aman] is not allowed to execute [workdocs:GetFolder] on the resource. To avoid that, use the ID in the folder's URL. site.workdocs/index.html#/folder/ abc123def456ghi789jkl789mno4be7024df198736472dd50ca970eb22796082e3d489577. Passing that ID returns a correct result. client.get_folder(FolderId='abc123def456ghi789jkl789mno4be7024df198736472dd50ca970eb22796082e3d489577') {'ResponseMetadata': {'RequestId': 'f8341d4e-4047-11e7-9e70-afa8d465756c', 'HTTPStatusCode': 200, 'HTTPHeaders': {'x-amzn-requestid': 'f234564e-1234-56e7-89e7- a10fa45t789c', 'cache-control': 'private, no-cache, no-store, max-age=0', 'content-type': 'application/json',
workdocs-dg-007	workdocs-dg.pdf	7	API call returns an UnauthorizedResourceAccessException message and the following 404 message. client.get_folder(FolderId='MyDocs') Traceback (most recent call last): File "<stdin>", line 1, in <module> File "C:\Users\user-name\AppData\Local\Programs\Python\Python36-32\lib\site-packages \botocore\client.py", line 253, in _api_call return self._make_api_call(operation_name, kwargs) File "C:\Users\user-name\AppData\Local\Programs\Python\Python36-32\lib\site-packages \botocore\client.py", line 557, in _make_api_call raise error_class(parsed_response, operation_name) botocore.errorfactory.UnauthorizedResourceAccessException: An error occurred (UnauthorizedResourceAccessException) when calling the GetFolder operation: Principal [arn:aws:iam::395162986870:user/Aman] is not allowed to execute [workdocs:GetFolder] on the resource. To avoid that, use the ID in the folder's URL. site.workdocs/index.html#/folder/ abc123def456ghi789jkl789mno4be7024df198736472dd50ca970eb22796082e3d489577. Passing that ID returns a correct result. client.get_folder(FolderId='abc123def456ghi789jkl789mno4be7024df198736472dd50ca970eb22796082e3d489577') {'ResponseMetadata': {'RequestId': 'f8341d4e-4047-11e7-9e70-afa8d465756c', 'HTTPStatusCode': 200, 'HTTPHeaders': {'x-amzn-requestid': 'f234564e-1234-56e7-89e7- a10fa45t789c', 'cache-control': 'private, no-cache, no-store, max-age=0', 'content-type': 'application/json', 'content-length': '733', 'date': 'Wed, 24 May 2017 06:12:30 GMT'}, 'RetryAttempts': 0}, 'Metadata': {'Id': 'abc123def456ghi789jkl789mno4be7024df198736472dd50ca970eb22796082e3d489577', 'Name': 'sentences', 'CreatorId': 'S-1-5-21-2125721135-1643952666-3011040551-2105&d-906724f1ce', 'ParentFolderId': '0a811a922403ae8e1d3c180f4975f38f94372c3d6a2656c50851c7fb76677363', 'CreatedTimestamp': datetime.datetime(2017, 5, 23, 12, 59, 13, 8000, tzinfo=tzlocal()), 'ModifiedTimestamp': datetime.datetime(2017, 5, 23, 13, 13, 9, 565000, tzinfo=tzlocal()), 'ResourceState': 'ACTIVE', 'Signature': 'b7f54963d60ae1d6b9ded476f5d20511'}} Using folder IDs in API calls 22 Amazon WorkDocs Developer Guide Create an application As an Amazon WorkDocs administrator, create your application using the following steps. To create an application 1. Open the Amazon WorkDocs console at https://console.aws.amazon.com/zocalo/. 2. Choose My Applications, Create an Application. 3. Enter the following values: Application Name Name for the application. Email Email address to associate with the application. Application Description Description for the application. Redirect URIs The location that you want Amazon WorkDocs to redirect traﬃc to. Application Scopes The scope, either read or write, that you wish your application to have. For more details, see Application scopes. 4. Choose Create. Application scopes Amazon WorkDocs supports the following application scopes: • Content Read (workdocs.content.read), which gives your application access to the following Amazon WorkDocs APIs: • Get* • Describe* Create an application 23 Amazon WorkDocs Developer Guide • Content Write (workdocs.content.write), which gives your application access to the following Amazon WorkDocs APIs: • Create* • Update* • Delete* • Initiate* • Abort* • Add* • Remove* Authorization After application registration is complete, an application can request authorization on behalf of any Amazon WorkDocs user. To do this, the application should visit the Amazon WorkDocs OAuth endpoint, https://auth.amazonworkdocs.com/oauth, and provide the following query parameters: • [Required] app_id—Application ID generated when an application is registered. • [Required] auth_type—The OAuth type for the request. Supported value is ImplicitGrant. • [Required] redirect_uri—The redirect URI registered for an application to receive an access token. • [Optional] scopes—A comma-deliminated list of scopes. If not speciﬁed, the list of scopes selected during registration will be used. • [Optional] state—A string which is returned along with an access token. Note If you require FIPS 140-2 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-2. A sample GET request to initiate the OAuth ﬂow to obtain an access token: Authorization 24 Amazon WorkDocs Developer Guide GET https://auth.amazonworkdocs.com/oauth?app_id=my-app- id&auth_type=ImplicitGrant&redirect_uri=https://myapp.com/ callback&scopes=workdocs.content.read&state=xyz The following takes place during the OAuth authorization ﬂow: 1. 2. The application user is prompted to enter the Amazon WorkDocs site name. The user is redirected to the Amazon WorkDocs authentication page to enter their credentials. 3. After successful authentication, the user is presented with the consent screen that allows the user to either grant or deny your application the authorization to access Amazon WorkDocs. 4. After the user chooses Accept on the consent screen, their browser is redirected to your application's callback URL along with the access token and region information as query parameters. A sample GET request from Amazon WorkDocs: GET https://myapp.com/callback?acessToken=accesstoken&region=us-east-1&state=xyz In addition to the access token, the Amazon WorkDocs OAuth service also returns region as a query parameter for the selected Amazon WorkDocs site. External applications should use the region parameter to determine the Amazon WorkDocs service endpoint. If you require FIPS 140-2 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-2. Invoking Amazon WorkDocs APIs After obtaining the access token, your application can make API calls to Amazon WorkDocs services. Important This example shows how to use a curl GET request to obtain a document's metadata. Invoking Amazon WorkDocs APIs 25 Amazon WorkDocs Developer Guide Curl "https://workdocs.us-east-1.amazonaws.com/api/v1/documents/{document-id}" -H "Accept: application/json" -H "Authentication: Bearer accesstoken" A sample JavaScript function to describe a user's root folders: function printRootFolders(accessToken, siteRegion) { var workdocs = new AWS.WorkDocs({region: siteRegion}); workdocs.makeUnauthenticatedRequest("describeRootFolders", {AuthenticationToken: accessToken}, function (err, folders) { if (err) console.log(err); else console.log(folders); }); } A sample Java-based API invocation is described below: AWSCredentialsProvider credentialsProvider = new AWSCredentialsProvider() { @Override public void refresh() {} @Override public AWSCredentials getCredentials() { new AnonymousAWSCredentials(); } }; // Set the correct region obtained during OAuth flow. workDocs = AmazonWorkDocsClient.builder().withCredentials(credentialsProvider) .withRegion(Regions.US_EAST_1).build(); DescribeRootFoldersRequest request = new DescribeRootFoldersRequest(); request.setAuthenticationToken("access-token-obtained-through-workdocs-oauth"); DescribeRootFoldersResult result =
workdocs-dg-008	workdocs-dg.pdf	8	WorkDocs APIs 25 Amazon WorkDocs Developer Guide Curl "https://workdocs.us-east-1.amazonaws.com/api/v1/documents/{document-id}" -H "Accept: application/json" -H "Authentication: Bearer accesstoken" A sample JavaScript function to describe a user's root folders: function printRootFolders(accessToken, siteRegion) { var workdocs = new AWS.WorkDocs({region: siteRegion}); workdocs.makeUnauthenticatedRequest("describeRootFolders", {AuthenticationToken: accessToken}, function (err, folders) { if (err) console.log(err); else console.log(folders); }); } A sample Java-based API invocation is described below: AWSCredentialsProvider credentialsProvider = new AWSCredentialsProvider() { @Override public void refresh() {} @Override public AWSCredentials getCredentials() { new AnonymousAWSCredentials(); } }; // Set the correct region obtained during OAuth flow. workDocs = AmazonWorkDocsClient.builder().withCredentials(credentialsProvider) .withRegion(Regions.US_EAST_1).build(); DescribeRootFoldersRequest request = new DescribeRootFoldersRequest(); request.setAuthenticationToken("access-token-obtained-through-workdocs-oauth"); DescribeRootFoldersResult result = workDocs.describeRootFolders(request); for (FolderMetadata folder : result.getFolders()) { System.out.printf("Folder name=%s, Id=%s \n", folder.getName(), folder.getId()); } Invoking Amazon WorkDocs APIs 26 Amazon WorkDocs Developer Guide Amazon WorkDocs Content Manager Amazon WorkDocs Content Manager is a high-level utility tool that uploads content or downloads it from an Amazon WorkDocs site. Topics • Constructing Amazon WorkDocs Content Manager • Downloading a document • Uploading a document Constructing Amazon WorkDocs Content Manager You can use Amazon WorkDocs Content Manager for administrative and user applications. For user applications, a developer must construct Amazon WorkDocs Content Manager with anonymous AWS credentials and an authentication token. For administrative applications, the Amazon WorkDocs client must be initialized with AWS Identity and Access Management (IAM) credentials. In addition, the authentication token must be omitted in subsequent API calls. The following code demonstrates how to initialize Amazon WorkDocs Content Manager for user applications using Java or C#. Java: AWSStaticCredentialsProvider credentialsProvider = new AWSStaticCredentialsProvider(new AnonymousAWSCredentials()); AmazonWorkDocs client = AmazonWorkDocsClient.builder().withCredentials(credentialsProvider).withRegion("region").build(); ContentManager contentManager = ContentManagerBuilder.standard().withWorkDocsClient(client).withAuthenticationToken("token").build(); C#: AmazonWorkDocsClient client = new AmazonWorkDocsClient(new AnonymousAWSCredentials(), "region"); Constructing Amazon WorkDocs Content Manager 27 Amazon WorkDocs Developer Guide ContentManagerParams params = new ContentManagerParams { WorkDocsClient = client, AuthenticationToken = "token" }; IContentManager workDocsContentManager = new ContentManager(param); Downloading a document Developers can use Amazon WorkDocs Content Manager to download a speciﬁc version or the latest version of a document from Amazon WorkDocs. The following examples demonstrate how to download a speciﬁc version of a document using Java and C#. Note To download the latest version of a document, do not specify the VersionId when constructing the GetDocumentStream request. Java ContentManager contentManager = ContentManagerBuilder.standard().withWorkDocsClient(client).withAuthenticationToken("auth- token").build(); // Download document. GetDocumentStreamRequest request = new GetDocumentStreamRequest(); request.setDocumentId("document-id"); request.setVersionId("version-id"); // stream contains the content of the document version. InputStream stream = contentManager.getDocumentStream(request).getStream(); C# ContentManager contentManager = ContentManagerBuilder.standard().withWorkDocsClient(client).withAuthenticationToken("auth- token").build(); // Download document. Downloading a document 28 Amazon WorkDocs Developer Guide GetDocumentStreamRequest request = new GetDocumentStreamRequest(); request.setDocumentId("document-id"); request.setVersionId("version-id"); // stream contains the content of the document version. InputStream stream = contentManager.getDocumentStream(request).getStream(); Uploading a document Amazon WorkDocs Content Manager provides an API for uploading content to an Amazon WorkDocs site. The following examples demonstrate how to upload a document using Java and C#. Java File file = new File("file-path"); InputStream stream = new FileInputStream(file); UploadDocumentStreamRequest request = new UploadDocumentStreamRequest(); request.setParentFolderId("destination-folder-id"); request.setContentType("content-type"); request.setStream(stream); request.setDocumentName("document-name"); contentManager.uploadDocumentStream(request); C# var stream = new FileStream("file-path", FileMode.Open); UploadDocumentStreamRequest uploadDocumentStreamRequest = new UploadDocumentStreamRequest() { ParentFolderId = "destination-id", DocumentName = "document-name", ContentType = "content-type", Stream = stream }; workDocsContentManager.UploadDocumentStreamAsync(uploadDocumentStreamRequest).Wait(); Uploading a document 29
workdocs-ug-001	workdocs-ug.pdf	1	User Guide Amazon WorkDocs Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon WorkDocs User Guide Amazon WorkDocs: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon WorkDocs Table of Contents User Guide ........................................................................................................................................................ vii What is Amazon WorkDocs ............................................................................................................. 1 Pricing ............................................................................................................................................................. 1 How to get started ...................................................................................................................................... 1 Getting started ................................................................................................................................ 2 System requirements ................................................................................................................................... 2 WorkDocs Drive for Windows ............................................................................................................... 3 WorkDocs Drive for macOS .................................................................................................................. 3 WorkDocs Drive for macOS (Apple Silicon) ....................................................................................... 4 Supported Android versions ................................................................................................................. 4 Supported iOS versions ......................................................................................................................... 5 WorkDocs for FireOS .............................................................................................................................. 5 Browser requirements ............................................................................................................................ 5 Support ending for the following operating systems ..................................................................... 6 Step 1: Get invited ....................................................................................................................................... 6 Step 2: Register ............................................................................................................................................ 7 (Optional) Install the mobile apps ............................................................................................................ 7 Step 4: Sign in to WorkDocs ...................................................................................................................... 7 Using WorkDocs on Android ...................................................................................................................... 8 Switching visual themes ........................................................................................................................ 9 Using WorkDocs on iOS ............................................................................................................................ 10 Viewing and editing ﬁles in other iOS apps ................................................................................... 11 Using the Files app in iOS .................................................................................................................. 11 Saving a ﬁle from another iOS app to Amazon WorkDocs .......................................................... 11 Switching visual themes ...................................................................................................................... 12 If you have trouble signing in ................................................................................................................. 12 Using Amazon WorkDocs Companion .......................................................................................... 13 System requirements ................................................................................................................................. 13 Installing Amazon WorkDocs Companion ............................................................................................ 14 Uninstalling Amazon WorkDocs Companion ........................................................................................ 14 Using Amazon WorkDocs Drive .................................................................................................... 16 Installing Amazon WorkDocs Drive ........................................................................................................ 17 Installing Amazon WorkDocs Drive on Windows devices ............................................................. 17 Installing Amazon WorkDocs Drive on macOS devices ................................................................. 18 iii Amazon WorkDocs User Guide Using the Windows Subsystem for Linux to mount Amazon WorkDocs Drive ......................... 19 Opening the Amazon WorkDocs Drive settings ................................................................................... 20 Uninstalling Amazon WorkDocs Drive ................................................................................................... 21 Logging out of Amazon WorkDocs Drive .............................................................................................. 22 Logging in to Amazon WorkDocs Drive after you log out ................................................................. 24 Using Amazon WorkDocs Drive ............................................................................................................... 24 Understanding the Amazon WorkDocs Drive ﬁle icons ................................................................ 25 Opening Amazon WorkDocs Drive folders ...................................................................................... 25 Creating folders in Amazon WorkDocs Drive .................................................................................. 26 Duplicating folders ............................................................................................................................... 26 Taking actions on folders .................................................................................................................... 26 Taking actions on ﬁles ......................................................................................................................... 27 Working oﬄine ...................................................................................................................................... 29 Reconnecting after working oﬄine .................................................................................................. 30 Pausing ﬁle sync ................................................................................................................................... 30 Searching Amazon WorkDocs Drive .................................................................................................. 30 Deleting ﬁles from Amazon WorkDocs Drive .................................................................................. 31 Quitting Amazon WorkDocs Drive .................................................................................................... 32 Restarting Amazon WorkDocs Drive after you quit ....................................................................... 33 Troubleshooting Amazon WorkDocs Drive ........................................................................................... 33 Reporting issues .................................................................................................................................... 36 Known limitations ................................................................................................................................. 36 Working with ﬁles ......................................................................................................................... 37 Naming ﬁles ................................................................................................................................................ 38 Creating ﬁles ............................................................................................................................................... 39 Opening ﬁles ............................................................................................................................................... 39 Uploading ﬁles ............................................................................................................................................ 40 Downloading ﬁles ...................................................................................................................................... 41 Downloading Word documents with feedback .................................................................................... 42 Marking ﬁles as favorites ......................................................................................................................... 42 Requesting approvals for ﬁles ................................................................................................................. 43 Changing ﬁle settings ............................................................................................................................... 45 Locking and unlocking ﬁles ..................................................................................................................... 45 Renaming ﬁles ............................................................................................................................................ 47 Moving ﬁles ................................................................................................................................................. 47 Transferring ﬁle ownership ...................................................................................................................... 48 iv Amazon WorkDocs User Guide Deleting ﬁles ............................................................................................................................................... 49 Viewing ﬁle activity ................................................................................................................................... 49 Sharing ﬁles ................................................................................................................................................. 50 Editing ﬁles .................................................................................................................................................. 50 Viewing ﬁles oﬄine ................................................................................................................................... 51 Using smart search .................................................................................................................................... 51 Managing the recycle bin (web only) .................................................................................................... 52 Working with ﬁle versions ............................................................................................................ 53 Understanding version creation .............................................................................................................. 53 How versions impact your storage limit ............................................................................................... 54 Deleting previous versions of a ﬁle ........................................................................................................ 54 Reducing the number of Amazon WorkDocs Drive versions ............................................................. 57 Using past versions of a ﬁle .................................................................................................................... 57 Reverting a ﬁle to a previous version .................................................................................................... 58 Working with folders .................................................................................................................... 59 Creating folders .......................................................................................................................................... 60 Opening folders .......................................................................................................................................... 62 Duplicating folders ..................................................................................................................................... 62 Downloading folders ................................................................................................................................. 62 Marking folders as favorites .................................................................................................................... 63 Requesting approvals for folders ............................................................................................................ 64 Renaming folders ....................................................................................................................................... 65 Moving folders ............................................................................................................................................ 66 Transferring folder ownership ................................................................................................................. 67 Deleting folders .......................................................................................................................................... 68 Viewing folder activity .............................................................................................................................. 68 Sharing folders ........................................................................................................................................... 69 Uploading folders ....................................................................................................................................... 69 Managing the recycle bin (web only) .................................................................................................... 69 Sharing ﬁles and folders ............................................................................................................... 70 Sharing link ................................................................................................................................................. 70 Sharing by invitation ................................................................................................................................. 71 Removing share permissions ................................................................................................................... 73 Removing yourself from a share ............................................................................................................. 74 Permissions .................................................................................................................................... 76 User roles ..................................................................................................................................................... 76 v Amazon WorkDocs User Guide Permissions for shared folders ................................................................................................................ 77 Permissions for ﬁles in shared folders .................................................................................................. 78 Permissions for ﬁles not in shared folders ........................................................................................... 80 Feedback and collaborative editing ............................................................................................. 82 Sharing feedback ........................................................................................................................................ 82 Sending messages ...................................................................................................................................... 87 Editing with Hancom ThinkFree .............................................................................................................. 87 Creating a new ﬁle ...............................................................................................................................
workdocs-ug-002	workdocs-ug.pdf	2	69 Uploading folders ....................................................................................................................................... 69 Managing the recycle bin (web only) .................................................................................................... 69 Sharing ﬁles and folders ............................................................................................................... 70 Sharing link ................................................................................................................................................. 70 Sharing by invitation ................................................................................................................................. 71 Removing share permissions ................................................................................................................... 73 Removing yourself from a share ............................................................................................................. 74 Permissions .................................................................................................................................... 76 User roles ..................................................................................................................................................... 76 v Amazon WorkDocs User Guide Permissions for shared folders ................................................................................................................ 77 Permissions for ﬁles in shared folders .................................................................................................. 78 Permissions for ﬁles not in shared folders ........................................................................................... 80 Feedback and collaborative editing ............................................................................................. 82 Sharing feedback ........................................................................................................................................ 82 Sending messages ...................................................................................................................................... 87 Editing with Hancom ThinkFree .............................................................................................................. 87 Creating a new ﬁle ............................................................................................................................... 88 Editing a ﬁle ........................................................................................................................................... 88 Using Open with Oﬃce Online ............................................................................................................... 89 Prerequisites ........................................................................................................................................... 89 Using Open with Oﬃce Online .......................................................................................................... 89 Working with approvals ................................................................................................................ 91 Creating approval requests ...................................................................................................................... 91 Responding to approval requests ........................................................................................................... 92 Updating approval requests ..................................................................................................................... 92 Canceling approval requests .................................................................................................................... 93 Viewing completed approval requests .................................................................................................. 93 Tracking ﬁle activity ...................................................................................................................... 95 Managing your Amazon WorkDocs account ................................................................................ 96 Updating your user proﬁle ....................................................................................................................... 96 Using Amazon WorkDocs for Amazon Business .......................................................................... 97 Viewing and searching for ﬁles ............................................................................................................... 97 Sharing and commenting on ﬁles .......................................................................................................... 98 Uploading and downloading ﬁles ........................................................................................................... 99 Moving, renaming, and deleting ﬁles .................................................................................................. 100 Viewing activity ........................................................................................................................................ 101 Document history ........................................................................................................................ 102 vi Amazon WorkDocs User Guide Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs. vii Amazon WorkDocs User Guide What is Amazon WorkDocs You use Amazon WorkDocs to store, manage, share, and collaborate on documents, spreadsheets, and other ﬁles with your coworkers. Amazon WorkDocs stores your ﬁles in the cloud, and you work with your ﬁles in a browser, or in the Amazon WorkDocs mobile app. Your ﬁles are only visible to you and your designated contributors and reviewers. Other users can't open, read, or change your ﬁles unless you grant them access. You can also share your ﬁles with other users for collaboration or review, and you can view many diﬀerent types of ﬁles, including all common document and image formats. Pricing Amazon WorkDocs has no upfront fees or commitments. For more information, see Pricing. How to get started For a hands-on introduction to Amazon WorkDocs, see the next section, Getting started with Amazon WorkDocs. Pricing 1 Amazon WorkDocs User Guide Getting started with Amazon WorkDocs The following sections explain how to get started using Amazon WorkDocs. You must complete the ﬁrst two steps in order to use Amazon WorkDocs in the cloud or on a mobile app. You can use Amazon WorkDocs in any of the supported browsers listed here. You can also use the Amazon WorkDocs mobile app on the supported Android and iOS devices listed here. In addition, you can install Amazon WorkDocs Drive on Windows and macOS machines. Amazon WorkDocs Drive enables you to open and work with Amazon WorkDocs ﬁles on your computer's desktop. For more information about Amazon WorkDocs Drive, see Using Amazon WorkDocs Drive. The following sections list the system requirements for using Amazon WorkDocs and explain how to get started. Contents • System requirements • Step 1: Get invited • Step 2: Register • 3: (Optional) Install the Amazon WorkDocs mobile apps • Step 4: Sign in to WorkDocs • Using WorkDocs on Android • Using WorkDocs on iOS • If you have trouble signing in System requirements Amazon WorkDocs is available on Windows, macOS, Android, and iOS. You can also use and on the web. Note Amazon WorkDocs isn't available on Linux. WorkDocs and Amazon WorkDocs Drive have the following system requirements. System requirements 2 Amazon WorkDocs User Guide WorkDocs Drive for Windows • Windows 11 • Windows 10 - version 20H1 or later • Windows 10 - 19H2 or earlier (until March 30, 2024) • Windows 10 - (until March 30, 2024) • Windows 8 (until March 30, 2024) • Windows 7 (until March 30, 2024) • Windows Server 2022 • Windows Server 2019 • Windows Server 2016 (until March 30, 2024) • Windows Server 2012 R2 (until March 30, 2024) • Windows Server 2008 (until March 30, 2024) Minimum hardware: • An Intel or AMD 64-bit CPU, 1 GB memory available for Drive to use. Installation dependencies: • .NET Framework 4.7.2 • Microsoft WebView2 runtime. • Firewall access to the .s3.amazonaws.com end point. WorkDocs Drive for macOS • macOS 13 • macOS 12 • macOS 11 (until March 30, 2024) • macOS 10 (until March 30, 2024) WorkDocs Drive for Windows 3 Amazon WorkDocs Minimum hardware: User Guide • Intel MacBooks with a minimum of Intel 64-bit CPU, 1 GB memory available for Drive to use. Installation dependencies: • Firewall access to the .s3.amazonaws.com end point. WorkDocs Drive for macOS (Apple Silicon) • macOS 13
workdocs-ug-003	workdocs-ug.pdf	3	64-bit CPU, 1 GB memory available for Drive to use. Installation dependencies: • .NET Framework 4.7.2 • Microsoft WebView2 runtime. • Firewall access to the .s3.amazonaws.com end point. WorkDocs Drive for macOS • macOS 13 • macOS 12 • macOS 11 (until March 30, 2024) • macOS 10 (until March 30, 2024) WorkDocs Drive for Windows 3 Amazon WorkDocs Minimum hardware: User Guide • Intel MacBooks with a minimum of Intel 64-bit CPU, 1 GB memory available for Drive to use. Installation dependencies: • Firewall access to the .s3.amazonaws.com end point. WorkDocs Drive for macOS (Apple Silicon) • macOS 13 • macOS 12.3+ Minimum hardware: • Apple silicon MacBooks with a minimum of Apple 64-bit CPU, 1 GB memory available for Drive to use. Installation dependencies: • Rosetta2 • Firewall access to the .s3.amazonaws.com end point. Supported Android versions • Android 13 • Android 12L • Android 12 • Android 11 • Android 10 • Android 9 (until March 30, 2024) • Android 8.1 (until March 30, 2024) • Android 8 (until March 30, 2024) • Android 7.1 (until March 30, 2024) WorkDocs Drive for macOS (Apple Silicon) 4 Amazon WorkDocs User Guide • Android 7 (until March 30, 2024) • Android 6 (until March 30, 2024) • Android 5.1 (until March 30, 2024) Supported iOS versions • iOS 16 • iOS 15 • iOS 14 • iOS 13 • iOS 12 WorkDocs for FireOS Supported FireOS versions: • FireOS 8 (until March 30, 2024) • FireOS 7 (until March 30, 2024) Browser requirements The Amazon WorkDocs web application supports the following web browsers. Open the Amazon WorkDocs' web application by signing in to https://site name.awsapps.com/ in a supported browser. Supported browsers: The Amazon WorkDocs web client requires one of the following browsers: • Google Chrome (Latest three major versions) • Mozilla Firefox (Latest three major versions) • Microsoft Edge (Latest three major versions) • Apple Safari for macOS (Latest three major versions) Supported iOS versions 5 Amazon WorkDocs User Guide Support ending for the following operating systems Important Active support for the following operating systems will end on March 30, 2024. After March 30, 2024, WorkDocs Drive will be available for use on these operating systems, but will no longer receive updates. Operating systems and end dates: • Windows 10 - 19H2 or earlier (until March 30, 2024) • Windows 8 (until March 30, 2024) • Windows 7 (until March 30, 2024) • Windows Server 2016 (until March 30, 2024) • Windows Server 2012 R2 (until March 30, 2024) • Windows Server 2008 (until March 30, 2024) • macOS 11 (until March 30, 2024) • macOS 10 (until March 30, 2024) • Android 9 (until March 30, 2024) • Android 8.1 (until March 30, 2024) • Android 8 (until March 30, 2024) • Android 7.1 (until March 30, 2024) • Android 7 (until March 30, 2024) • Android 6 (until March 30, 2024) • Android 5.1 (until March 30, 2024) • FireOS 8 (until March 30, 2024) • FireOS 7 (until March 30, 2024) Step 1: Get invited You must be invited to join an Amazon WorkDocs organization. Your Amazon WorkDocs administrator creates an organization and invites you and other users to join it. The administrator Support ending for the following operating systems 6 Amazon WorkDocs User Guide can also grant "invite" privileges to people in the organization, and in turn they can invite others to join. Your Amazon WorkDocs administrator sends you an email message with the information needed to sign in and register—if necessary—and instructions on how to download the client applications. Important Save your invitation email, or save the address of the person who sent the email. You may need to contact that person for help with tasks that only administrators can do, such as enabling Hancom Thinkfree. Step 2: Register When you receive your invitation to join an Amazon WorkDocs organization, you may need to register. That involves entering your user information, which includes the following: • First name • Last name • Password You can change your proﬁle photo, time zone, and password after you register. For more information, see Updating your user proﬁle. 3: (Optional) Install the Amazon WorkDocs mobile apps You can install Amazon WorkDocs on supported versions of Android and iOS. For more information, see Supported Android versions and Supported iOS versions. earlier in this guide. • For Android, download the app from Google Play or the Amazon Appstore for Android. • For iOS, download the app from the Apple App Store. Step 4: Sign in to WorkDocs The following sets of steps explain how to sign in to WorkDocs on the web and the Android and iOS apps. Step 2: Register 7 Amazon WorkDocs Note User Guide • The welcome email message from your administrator has the URL, organization, and
workdocs-ug-004	workdocs-ug.pdf	4	install Amazon WorkDocs on supported versions of Android and iOS. For more information, see Supported Android versions and Supported iOS versions. earlier in this guide. • For Android, download the app from Google Play or the Amazon Appstore for Android. • For iOS, download the app from the Apple App Store. Step 4: Sign in to WorkDocs The following sets of steps explain how to sign in to WorkDocs on the web and the Android and iOS apps. Step 2: Register 7 Amazon WorkDocs Note User Guide • The welcome email message from your administrator has the URL, organization, and user name that you use to sign in. You set the password when you registered. For more information, see Step 2: Register. If your Amazon WorkDocs administrator has enabled multi-factor authentication (MFA) for your organization, you are also prompted for a passcode to ﬁnish signing in. Your Amazon WorkDocs administrator provides information about how to get your passcode. • If your administrator enables single sign-on, you can use your regular network credentials to sign in to Amazon WorkDocs. However, you may need to take additional steps to allow your browser to support single sign-on. For more information, see Single sign-on for IE and Chrome and Single sign-on for Firefox in the AWS Directory Service Administration Guide. • To reset your password, choose Forgot password on the sign-in screen. The screen appears in WorkDocs on the web, and the Android and iOS apps. If you need help signing in, contact your administrator. Signing in to WorkDocs on the web 1. Open any of the approved browsers and enter the URL provided by your administrator. 2. To start Amazon WorkDocs for the ﬁrst time, enter your organization name, your user name, and your password. Signing in to WorkDocs for Android or iOS • To sign in to any of the apps, enter your organization name, user name, and password. Using WorkDocs on Android The Amazon WorkDocs app for Android allows you to view, comment on, and download your Amazon WorkDocs ﬁles. You can also view, give feedback on, and download other documents if you have permissions to do so. Contents • Switching visual themes Using WorkDocs on Android 8 Amazon WorkDocs User Guide Switching visual themes By default, the Amazon WorkDocs mobile app uses your device's visual theme. You can switch visual themes by changing your device's theme, or you can change a setting in the app. Usually, you switch to the dark theme when you want to reduce eye strain. The dark theme can also improve battery life. The following steps explain how to switch themes independently of your device's visual theme. To switch themes in the mobile app 1. Start the Amazon WorkDocs mobile app. 2. Open the program menu in the upper-left corner of the app. 3. On the menu that appears, choose Settings. 4. Choose Theme. 5. Move the Use device appearance slider to the oﬀ position. 6. Choose Dark or Light. The app saves your changes automatically. The following steps explain how to change the visual theme on an older Motorola phone. The steps that you follow may vary, depending on your device and version of Android. Switching visual themes 9 Amazon WorkDocs User Guide To switch themes in your device settings 1. Open the settings for your device. If you don't know how to open the settings, see the help for your device. 2. Choose Display. Note This step may vary, depending on your device and your version of Android. If it does, see the help for your device. 3. Move the Dark theme slider to the on or oﬀ position as desired. Note This step may vary, depending on your device and your version of Android. If it does, see the help for your device. Using WorkDocs on iOS The Amazon WorkDocs applications for iPhone and iPad allow you to view, comment on, and download your Amazon WorkDocs ﬁles. You can also view, give feedback on, and download other documents if you have permissions to do so. Also, the iPhone and iPad applications allow you to view and edit ﬁles in other iOS apps, and you can save ﬁles from other iOS apps to Amazon WorkDocs. Contents • Viewing and editing ﬁles in other iOS apps • Using the Files app in iOS • Saving a ﬁle from another iOS app to Amazon WorkDocs • Switching visual themes Using WorkDocs on iOS 10 Amazon WorkDocs User Guide Viewing and editing ﬁles in other iOS apps You can open an Amazon WorkDocs ﬁle in any other iOS app that supports ﬁle sharing. After opening the ﬁle, you can view or edit it in the other app, then save it back to Amazon WorkDocs. To open a ﬁle in another iOS app 1. Open the Amazon WorkDocs
workdocs-ug-005	workdocs-ug.pdf	5	WorkDocs. Contents • Viewing and editing ﬁles in other iOS apps • Using the Files app in iOS • Saving a ﬁle from another iOS app to Amazon WorkDocs • Switching visual themes Using WorkDocs on iOS 10 Amazon WorkDocs User Guide Viewing and editing ﬁles in other iOS apps You can open an Amazon WorkDocs ﬁle in any other iOS app that supports ﬁle sharing. After opening the ﬁle, you can view or edit it in the other app, then save it back to Amazon WorkDocs. To open a ﬁle in another iOS app 1. Open the Amazon WorkDocs ﬁle that you want to open in another app. 2. Choose Menu, Share, and then select the app with which to open the ﬁle. To save the ﬁle to Amazon WorkDocs, see Saving a ﬁle from another iOS app to Amazon WorkDocs. Using the Files app in iOS Use the Files app in iOS version 11 or later to view, edit, lock, unlock, add, copy, move, and delete Amazon WorkDocs content that you have permissions for. To use Amazon WorkDocs with the iOS Files app 1. 2. Install the Amazon WorkDocs iOS app on your iOS device and sign in. In the Files app, choose Locations, Edit, then turn on Amazon WorkDocs. 3. Choose Done, then choose Workdocs to browse your ﬁles in the Files app. To open and manage content directly in the Amazon WorkDocs app, choose Open in WorkDocs from the Files app menu. You can now access the feedback and sharing features. Saving a ﬁle from another iOS app to Amazon WorkDocs You can save a ﬁle to Amazon WorkDocs from any iOS app that supports ﬁle sharing. This makes the ﬁle available on other Amazon WorkDocs mobile apps and the web client. You can also use the Files app in iOS version 11 or later to save your ﬁle to Amazon WorkDocs. To save a ﬁle from another iOS app to Amazon WorkDocs 1. Choose the ﬁle, photo, or attachment from any iOS app that supports ﬁle sharing. 2. Choose the export function in the app (this appears under diﬀerent names, depending on the app), and choose WorkDocs iOS app. Viewing and editing ﬁles in other iOS apps 11 Amazon WorkDocs Note User Guide If WorkDocs iOS app doesn’t appear in the list of apps, choose Browse more and slide the toggle to choose WorkDocs iOS app. 3. Select an Amazon WorkDocs folder and choose Save. Switching visual themes You can switch visual themes by changing a setting in the Amazon WorkDocs mobile app, or by changing your device settings. Usually, you switch to the Dark theme when you want to reduce eye strain. The Dark theme can also improve battery life. To switch themes in the mobile app 1. Open your settings and choose Theme. 2. If it's on, turn oﬀ Use device appearance. 3. Choose Dark or Light. To switch themes in device settings 1. Open your settings and choose Theme. 2. Choose Dark or Light. If you have trouble signing in If you have trouble signing in to Amazon WorkDocs, contact your administrator, the person who invited you to start using Amazon WorkDocs. Switching visual themes 12 Amazon WorkDocs User Guide Using Amazon WorkDocs Companion Important Amazon WorkDocs Companion is reaching end of life and will no longer be available starting on April 25, 2025, the end of Life (EOL) date for Amazon WorkDocs. Amazon WorkDocs Companion lets you open and edit a ﬁle from the web client in one step. When you edit a ﬁle, Companion saves your changes to Amazon WorkDocs as a new ﬁle version. Note You never use Amazon WorkDocs Companion directly. All you need to do is work with your ﬁles. For Windows users, Amazon WorkDocs Companion integrates with File Explorer to let you: • Upload multiple ﬁles and folders from File Explorer to the Companion Uploads folder under MyDocs on the Amazon WorkDocs site. • Share a link to the uploaded ﬁles, or share a link with a 4-digit passcode. Contents • System requirements • Installing Amazon WorkDocs Companion • Uninstalling Amazon WorkDocs Companion System requirements To use Amazon WorkDocs Companion, you must meet the following requirements: • You must have owner, co-owner, or contributor permissions for a ﬁle. • Your must run Windows 7 or later, or macOS 10.12 or later. • You must have one of the following browsers: System requirements 13 User Guide Amazon WorkDocs • Google Chrome • Mozilla Firefox • The ﬁle type must be one of the following: • Microsoft Oﬃce Word • Microsoft Oﬃce Excel • Microsoft Oﬃce PowerPoint • PDF • Text ﬁle with a .txt ﬁle extension Installing Amazon WorkDocs Companion You install Amazon WorkDocs Companion by downloading and running an installation program. To install Amazon WorkDocs Companion
workdocs-ug-006	workdocs-ug.pdf	6	• You must have owner, co-owner, or contributor permissions for a ﬁle. • Your must run Windows 7 or later, or macOS 10.12 or later. • You must have one of the following browsers: System requirements 13 User Guide Amazon WorkDocs • Google Chrome • Mozilla Firefox • The ﬁle type must be one of the following: • Microsoft Oﬃce Word • Microsoft Oﬃce Excel • Microsoft Oﬃce PowerPoint • PDF • Text ﬁle with a .txt ﬁle extension Installing Amazon WorkDocs Companion You install Amazon WorkDocs Companion by downloading and running an installation program. To install Amazon WorkDocs Companion 1. Start Amazon WorkDocs and choose Apps. The Apps page appears. 2. Under Companion App, choose PC or Mac. The next step depends on your choice. • If you chose PC, the Opening Amazon WorkDocs Companion.msi dialog box appears. Choose Save File. • If you chose Mac, the Opening Amazon WorkDocs Companion.pkg dialog box appears. Choose OK. Either choice saves the ﬁle to your download folder. 3. When the download ﬁnishes, open the ﬁle and follow the steps in the installation program. Uninstalling Amazon WorkDocs Companion The following steps explain how to uninstall Amazon WorkDocs Companion from PCs and Macs. Installing Amazon WorkDocs Companion 14 Amazon WorkDocs To uninstall from a PC 1. Choose Start, and then choose Settings. The Windows Settings page appears. User Guide 2. Choose Apps, and then choose Amazon WorkDocs Companion. 3. Choose Uninstall, and on the message that appears, choose Uninstall again. You remove Amazon WorkDocs Companion from a Mac by ﬁrst stopping the app, and then removing it. Follow these steps. To uninstall from a Mac 1. On the menu bar, right-click the Amazon WorkDocs Companion icon, and then choose About Amazon WorkDocs Companion. The About screen appears. 2. Choose Stop Application. Companion stops running, and the About screen closes. 3. Choose Finder, and then choose Applications. 4. Locate the Amazon WorkDocs Companion icon and drag it to the trash bin. Uninstalling Amazon WorkDocs Companion 15 Amazon WorkDocs User Guide Using Amazon WorkDocs Drive Amazon WorkDocs Drive enables you to open and work with Amazon WorkDocs ﬁles on your computer's desktop. By default, Amazon WorkDocs Drive appears on your computer as drive W:, and you use Amazon WorkDocs Drive like you would any other disc drive. Note You must belong to a network domain in order to use Amazon WorkDocs Drive. Also, your system administrator may assign a diﬀerent drive letter. If you're unsure about your network domain or drive letter, contact your administrator. Amazon WorkDocs Drive is available for PC and macOS users, and for WorkSpaces on Windows. Amazon WorkDocs Drive can upload and download ﬁles of up to 5 TB each, and allows ﬁle path lengths of up to 260 characters. Note Amazon WorkDocs Drive only creates links to your ﬁles. It doesn't write copies to your hard drive. For example, say you open a word processor ﬁle from Amazon WorkDocs Drive. Editing that ﬁle changes the current version of the ﬁle in Amazon WorkDocs. Important If you delete a link in Amazon WorkDocs Drive you also delete the source ﬁle in Amazon WorkDocs Also, the links created by Amazon WorkDocs Drive use a small amount of storage, and deleting them doesn't save any signiﬁcant storage space. Topics • Installing Amazon WorkDocs Drive • Opening the Amazon WorkDocs Drive settings • Uninstalling Amazon WorkDocs Drive • Logging out of Amazon WorkDocs Drive 16 Amazon WorkDocs User Guide • Logging in to Amazon WorkDocs Drive after you log out • Using Amazon WorkDocs Drive • Troubleshooting Amazon WorkDocs Drive Installing Amazon WorkDocs Drive The steps in the following sections explain how to install Amazon WorkDocs Drive on Windows and macOS devices. Note • You must have access to a WorkDocs site before you can install Amazon WorkDocs Drive. For information about installing WorkDocs, see Getting started with Amazon WorkDocs. • You must be an administrator on your device to install Amazon WorkDocs Drive. For information about determining whether you're an administrator, see the help for your operating system, or contact your system administrator. • You can't install Amazon WorkDocs Drive on iOS or Android devices. Topics • Installing Amazon WorkDocs Drive on Windows devices • Installing Amazon WorkDocs Drive on macOS devices • Using the Windows Subsystem for Linux to mount Amazon WorkDocs Drive Installing Amazon WorkDocs Drive on Windows devices The following steps explain how to install Amazon WorkDocs Drive on Windows and Windows Server. Amazon WorkDocs Drive runs on 64-bit versions of Windows 10 and 11, Windows Server 2016, Windows Server 2019, and Windows Server 2022. To install Amazon WorkDocs Drive on Windows devices 1. Download and install Microsoft .NET Framework 4.8 or later. Go to https:// dotnet.microsoft.com/download/dotnet-framework and follow the instructions. 2. Using the address (URL) provided by your administrator,
workdocs-ug-007	workdocs-ug.pdf	7	devices • Installing Amazon WorkDocs Drive on macOS devices • Using the Windows Subsystem for Linux to mount Amazon WorkDocs Drive Installing Amazon WorkDocs Drive on Windows devices The following steps explain how to install Amazon WorkDocs Drive on Windows and Windows Server. Amazon WorkDocs Drive runs on 64-bit versions of Windows 10 and 11, Windows Server 2016, Windows Server 2019, and Windows Server 2022. To install Amazon WorkDocs Drive on Windows devices 1. Download and install Microsoft .NET Framework 4.8 or later. Go to https:// dotnet.microsoft.com/download/dotnet-framework and follow the instructions. 2. Using the address (URL) provided by your administrator, start Amazon WorkDocs. Installing Amazon WorkDocs Drive 17 Amazon WorkDocs User Guide 3. On the blue command bar, choose Apps. 4. In the Apps dialog box, under Drive App, choose PC. WorkDocs downloads the installation package. Your browser displays the download and prompts you to open it. 5. Open the installation package and follow the installation prompts. 6. When installation completes, start Amazon WorkDocs Drive and when prompted, enter the name of your WorkDocs site, user name, and password. Installing Amazon WorkDocs Drive on macOS devices The following steps explain how to install Amazon WorkDocs Drive on macOS devices, including Intel and Apple silicon machines. Note You must have access to WorkDocs to complete these steps. For information about getting started with WorkDocs, see Getting started with Amazon WorkDocs. If you have an Intel machine, you must have macOS 11 or later. If you have an Apple silicon machine, you must have Monterey 12.3 or later. To install Amazon WorkDocs Drive on Intel machines 1. Start Amazon WorkDocs and on the blue command bar, choose Apps. 2. In the Apps dialog box, under Drive App, choose Mac. WorkDocs downloads the installation package. Your browser displays the download and prompts you to open it. 3. Open the installation package and follow the installation prompts. Installing Amazon WorkDocs Drive on macOS devices 18 Amazon WorkDocs User Guide 4. Choose the WorkDocs Drive icon on the menu bar. 5. 6. In the WorkDocs Drive window, choose Open Drive in Finder. When prompted to update the system extension, choose Open Security Preference. In the Security Preferences window, choose the lock icon, enter your credentials, and choose Allow for System software from developer "AMZN Mobile LLC" has been updated. 7. Restart the machine. To install Amazon WorkDocs Drive on macOS Apple silicon machines 1. Start Amazon WorkDocs and on the blue command bar, choose Apps. 2. In the Apps dialog box, under Drive App, choose Apple silicon. WorkDocs downloads the installation package. Your browser displays the download and prompts you to open it. 3. Open the installation package and follow the installation prompts. 4. Start Finder, go to Locations, and verify that the WorkDocs folder is present. You may be prompted to enable WorkDocs. If so, choose the button in the upper-right corner. Note If you don't see the WorkDocs folder, make sure you enable Cloud Storage in your Finder preferences. Using the Windows Subsystem for Linux to mount Amazon WorkDocs Drive If you run the Windows Subsystem for Linux, you can use the following Bash commands to mount Amazon WorkDocs Drive for PC. $ sudo mkdir /mnt/w $ sudo mount -t drvfs W: /mnt/w Using the Windows Subsystem for Linux to mount Amazon WorkDocs Drive 19 Amazon WorkDocs $ cd /mnt/w $ ls User Guide Opening the Amazon WorkDocs Drive settings The following steps explain how to open the Amazon WorkDocs Drive settings on Windows and macOS Intel machines. Settings for Apple silicon machines are not yet available. You use the settings to complete several tasks, such as logging out and back in, and working oﬄine. To open the settings on Windows machines 1. On the Windows task bar, choose the up arrow, near the lower-right corner of your screen. A pop-up window appears and displays a set of icons. 2. Choose the WorkDocs Drive icon. The The Amazon WorkDocs Drive task pane appears. 3. On the right side of the pane's title bar, choose the settings (gear) icon. A menu appears and lists the tasks you can perform. 4. Choose the desired task. Opening the Amazon WorkDocs Drive settings 20 Amazon WorkDocs User Guide To open the settings on macOS Intel machines 1. On the menu bar at the top of your screen, choose the Drive icon. 2. Choose the Amazon WorkDocs Drive icon. The Amazon WorkDocs Drive pane appears. 3. On the right side of the pane's title bar, choose the settings (gear) icon. 4. From the menu that appears, choose the desired task. Uninstalling Amazon WorkDocs Drive These steps explain how to uninstall Amazon WorkDocs Drive from Windows macOS, and Apple silicon machines. To uninstall Amazon WorkDocs Drive from Windows machines 1. Open the Amazon WorkDocs Drive settings and choose Quit
workdocs-ug-008	workdocs-ug.pdf	8	Guide To open the settings on macOS Intel machines 1. On the menu bar at the top of your screen, choose the Drive icon. 2. Choose the Amazon WorkDocs Drive icon. The Amazon WorkDocs Drive pane appears. 3. On the right side of the pane's title bar, choose the settings (gear) icon. 4. From the menu that appears, choose the desired task. Uninstalling Amazon WorkDocs Drive These steps explain how to uninstall Amazon WorkDocs Drive from Windows macOS, and Apple silicon machines. To uninstall Amazon WorkDocs Drive from Windows machines 1. Open the Amazon WorkDocs Drive settings and choose Quit Amazon WorkDocs Drive. If you don't remember how to open the settings, see Opening the Amazon WorkDocs Drive settings. 2. Start Control Panel, choose Programs and Features, Amazon WorkDocs Drive, Uninstall, and then choose OK. To uninstall Amazon WorkDocs Drive from macOS Intel machines 1. On the menu bar, choose the Amazon WorkDocs Drive icon, choose the gear icon, then choose Quit Amazon Workdocs Drive. Uninstalling Amazon WorkDocs Drive 21 Amazon WorkDocs User Guide 2. From the Applications folder, choose the Amazon WorkDocs Drive icon, then choose Move to Trash. 3. Navigate to ~/.conﬁg/Amazon/AWSWorkDocsDriveClient on your hard drive and remove the WorkDocs folder and any sub folders. Finally, navigate to ~/Library/Caches/ and empty your WorkDocs cache. You can remove Amazon WorkDocs Drive from macOS Apple silicon machines manually by using the Applications folder, or you can use the command line. The following steps explain how to use both methods. To uninstall Amazon WorkDocs Drive from macOS Apple silicon devices (manual) 1. Open the Applications folder. 2. Open the WorkDocs Drive context menu and choose Show package contents. 3. 4. Select the macOS folder. Tap and hold (double-click) to uninstall Amazon WorkDocs Drive. To uninstall Amazon WorkDocs Drive from macOS Apple silicon devices (command line) • Open Terminal and run the following command. Enter the command on a single line with no line breaks, and enter your password when prompted. sudo /Applications/WorkDocs\ Drive.app/Contents/MacOS/uninstall.app/ Contents/MacOs/uninstall Logging out of Amazon WorkDocs Drive By default, Amazon WorkDocs Drive logs in to your Amazon WorkDocs site when you start or restart your computer, but you can log Amazon WorkDocs Drive out at any time. Typically, you log Amazon WorkDocs Drive out when you want to save network bandwidth or connect it to a diﬀerent Amazon WorkDocs site. Logging out of Amazon WorkDocs Drive 22 Amazon WorkDocs Note User Guide Before you log out, note the URL of your Amazon WorkDocs site. To do that, choose the My account icon in the upper-right corner of the Amazon WorkDocs screen and note the Site name value. To log out of Amazon WorkDocs Drive 1. In Windows, Open the Amazon WorkDocs Drive settings and choose Log out (change site). If you don't remember how to open the settings, see Opening the Amazon WorkDocs Drive settings. —OR— On a Macintosh, on the menu bar, choose the Amazon WorkDocs Drive icon, choose the gear icon, then choose Log out. A login screen appears, and the Amazon WorkDocs Drive icon appears in your Windows Task Bar or Macintosh menu bar. 2. Leave the login screen open while you work oﬄine, and then follow the steps in the next section to log back in to Amazon WorkDocs Drive. Logging out of Amazon WorkDocs Drive 23 Amazon WorkDocs User Guide Logging in to Amazon WorkDocs Drive after you log out When you manually log out of Amazon WorkDocs Drive, a restart screen appears. If you don't see the screen, look for and choose the Amazon WorkDocs Drive icon on your Windows Task Bar or Macintosh menu bar. To log in to Amazon WorkDocs Drive after you log out 1. In the log in screen, enter the indicated part of your Amazon WorkDocs URL. 2. Choose Next. Amazon WorkDocs Drive reconnects to your Amazon WorkDocs site. Using Amazon WorkDocs Drive The topics in this section explain how to use Amazon WorkDocs Drive to manage ﬁles and folders on your computer desktop. Actions include creating, copying, renaming, moving, and deleting ﬁles and folders. Topics • Understanding the Amazon WorkDocs Drive ﬁle icons • Opening Amazon WorkDocs Drive folders • Creating folders in Amazon WorkDocs Drive • Duplicating folders • Taking actions on folders • Taking actions on ﬁles • Working oﬄine • Reconnecting after working oﬄine • Pausing ﬁle sync • Searching for ﬁles and folders on Amazon WorkDocs Drive • Deleting ﬁles from Amazon WorkDocs Drive • Quitting Amazon WorkDocs Drive Logging in to Amazon WorkDocs Drive after you log out 24 Amazon WorkDocs User Guide • Restarting Amazon WorkDocs Drive after you quit Understanding the Amazon WorkDocs Drive ﬁle icons Amazon WorkDocs Drive uses these icons to communicate ﬁle status: Icon Name Gray arrow Description File is syncing to the cloud. Blue cloud
workdocs-ug-009	workdocs-ug.pdf	9	• Duplicating folders • Taking actions on folders • Taking actions on ﬁles • Working oﬄine • Reconnecting after working oﬄine • Pausing ﬁle sync • Searching for ﬁles and folders on Amazon WorkDocs Drive • Deleting ﬁles from Amazon WorkDocs Drive • Quitting Amazon WorkDocs Drive Logging in to Amazon WorkDocs Drive after you log out 24 Amazon WorkDocs User Guide • Restarting Amazon WorkDocs Drive after you quit Understanding the Amazon WorkDocs Drive ﬁle icons Amazon WorkDocs Drive uses these icons to communicate ﬁle status: Icon Name Gray arrow Description File is syncing to the cloud. Blue cloud File resides in the cloud. Green checkmark File resides on your device. Blue star File or folder marked as a Favorite. Red lock File locked for editing. Opening Amazon WorkDocs Drive folders You open folders in Amazon WorkDocs Drive the same way that you open folders on a regular drive. Just remember that Amazon WorkDocs Drive appears as drive W:. Note By default, Amazon WorkDocs Drive displays two top-level folders — My Documents and Shared With Me. You can't create additional top-level folders. You can create sub-folders in those top-level folders. You can also take actions on the top-level and sub-folders, such as copying their web links or opening them in your browser. For more information, see the next section, Taking actions on folders. Understanding the Amazon WorkDocs Drive ﬁle icons 25 Amazon WorkDocs User Guide Creating folders in Amazon WorkDocs Drive You create folders in Amazon WorkDocs Drive the same way that create them on a regular drive. However, you can only create them as sub-folders in your MyDocs or Shared With Me top-level folders. You can't create additional top-level folders. You can create as many sub-folders levels as desired. Duplicating folders Amazon WorkDocs doesn't provide a command for duplicating folders. However, you can use Amazon WorkDocs Drive to create copies of the folders, and those copies appear in the web client. Remember the following: • Copying a folder also copies its subfolders and ﬁles. • You must own a folder in order to copy it, or have permission from a folder's owner to copy it. To copy a folder 1. Start Finder (macOS) or Explorer (Windows) and expand drive W. 2. Open the My Documents or Shared With Me folder. 3. Use your preferred method to copy and paste the desired folder. The system appends - copy to the folder name, and the copied folder appears in the web client. Taking actions on folders You can perform several actions on folders, such as copying a folder's web link or opening the folder in a browser. The actions vary, depending on whether you use a top-level folder, such as MyDocs, or a sub folder. These steps apply to Windows and macOS computers. Creating folders in Amazon WorkDocs Drive 26 Amazon WorkDocs User Guide Actions you can take on top-level folders 1. In Windows Explorer or Finder, expand W:. 2. Right-click or tap and hold a top-level folder, such as MyDocs, and point to Amazon WorkDocs Drive. 3. Do one of the following: • • Choose Copy web link, choose OK, then paste the copied link into your browser's address bar, an email, or wherever you need to use it. Choose Open in browser to open the folder in your browser. Actions you can take on sub-folders 1. In Windows Explorer or Finder, expand W:. 2. Right-click or tap and hold a sub-folder and point to Amazon WorkDocs Drive. 3. Do one of the following: • • • Choose Copy web link, choose OK, then paste the copied link into your browser's address bar, an email, or wherever you need to use it. Choose Open in browser to open the folder in your browser. Choose Add to favorites to add the folder to you list of favorites. Taking actions on ﬁles You can take several actions on ﬁles in Amazon WorkDocs Drive, such as creating, renaming, and deleting them. Remember the following: Taking actions on ﬁles 27 Amazon WorkDocs Note User Guide • When you delete a ﬁle in Amazon WorkDocs Drive you only delete a link from your local drive, but you move the source ﬁle to the Recycle bin on your site. Moving a ﬁle out of Amazon WorkDocs Drive also has the same eﬀect. • If you add ﬁles to a folder, and those ﬁles have identical names but diﬀerent upper and lowercase letters, only one of the ﬁles appears in Amazon WorkDocs. For example, if you have MyFile.doc and myFile.doc, only one of those ﬁles appears on the site. The operating system controls which ﬁle appears. • If multiple users edit a ﬁle simultaneously, their changes can overwrite each other. To avoid editing conﬂicts, always lock a ﬁle whenever you need to change it. See the
workdocs-ug-010	workdocs-ug.pdf	10	bin on your site. Moving a ﬁle out of Amazon WorkDocs Drive also has the same eﬀect. • If you add ﬁles to a folder, and those ﬁles have identical names but diﬀerent upper and lowercase letters, only one of the ﬁles appears in Amazon WorkDocs. For example, if you have MyFile.doc and myFile.doc, only one of those ﬁles appears on the site. The operating system controls which ﬁle appears. • If multiple users edit a ﬁle simultaneously, their changes can overwrite each other. To avoid editing conﬂicts, always lock a ﬁle whenever you need to change it. See the steps in the next section for information about locking ﬁles. In addition to creating, renaming, and so on, Amazon WorkDocs Drive also provides several other actions, and the steps in this section explain how to complete them. These steps apply to Windows and macOS computers. 1. In Windows Explorer or Apple's Finder, expand W:. 2. Open the folder that contains the ﬁle that you want to take action on. 3. Right-click or tap and hold the ﬁle name, then choose Amazon WorkDocs Drive. 4. On the menu that appears, do any of the following: • To generate a link for sharing content with other users, choose Copy web link. • To view or edit content in a web browser, choose Open in browser. • To allow speciﬁc users to access a ﬁle, choose Share by invite. • To mark a ﬁle or folder as a favorite, choose Add to Favorites. • To prevent others from changing a ﬁle while you work on it, choose Lock and Edit. When you're done, right-click or tap and hold the ﬁle name and choose Unlock. Taking actions on ﬁles 28 Amazon WorkDocs Working oﬄine User Guide If you think you might lose network access, you can set Amazon WorkDocs Drive to work oﬄine. Enabling oﬄine access to your ﬁles and folders downloads ﬁles to your computer. You then work on them, and upload your changes to Amazon WorkDocs when you go back online. Note Enabling oﬄine access uses network bandwidth to download your content, plus space on your hard drive for storing the ﬁles. Downloads can take time, depending on the size and number of ﬁles and your network bandwidth. To enable oﬄine access to your content 1. Open the Amazon WorkDocs Drive settings. If you don't remember how to open the settings, see Opening the Amazon WorkDocs Drive settings. 2. Choose Work oﬄine. The Sync settings dialog box appears. 3. Select Choose ﬁles for oﬄine access. 4. Choose Next. 5. Select the ﬁles that you want to save to your computer. Note The size of the selected ﬁles appears in the Sync settings pane, along with the amount of space on your hard drive. 6. Choose Save. 7. Wait for Amazon WorkDocs Drive to download your ﬁles. This can take some time. The ﬁles appear in File Explorer on your W drive. Choose My Documents or Shared With Me to open and use the ﬁles. Working oﬄine 29 Amazon WorkDocs User Guide Reconnecting after working oﬄine To stop oﬄine syncing, you set Amazon WorkDocs Drive to access ﬁles on demand. Follow these steps. To access your content on demand 1. Do one of the following: • Open the Amazon WorkDocs Drive settings. If you don't remember how to open the settings, see Opening the Amazon WorkDocs Drive settings. • On a macOS machine, on the menu bar, choose the Amazon WorkDocs Drive icon, the choose the gear icon. 2. Choose Work oﬄine. 3. For Sync settings, select Access ﬁles on demand. 4. Choose OK. Pausing ﬁle sync If you have network bandwidth issues, you can download ﬁles, pause ﬁle syncing, then resume syncing after you make your changes. To pause ﬁle syncing 1. Open the Amazon WorkDocs Drive settings. If you don't remember how to open the settings, see Opening the Amazon WorkDocs Drive settings. 2. Choose Pause ﬁle sync, then work on your downloaded ﬁles. 3. To resume syncing, repeat steps 1 and 2, then clear Pause ﬁle sync. Amazon WorkDocs Drive uploads your changed ﬁles as new versions. Searching for ﬁles and folders on Amazon WorkDocs Drive You can use several tools to search for ﬁles stored on Amazon WorkDocs Drive. Reconnecting after working oﬄine 30 Amazon WorkDocs Note Remember that a WorkDocs Drive search is case sensitive. User Guide To search Amazon WorkDocs Drive in Windows Do one of the following: • In Windows File Explorer, right-click the Amazon WorkDocs Drive icon, point to Amazon WorkDocs Drive, choose Search, then enter a search term. • Open the Amazon WorkDocs Drive task pane and enter a term in the search box. If you don't remember how to open the pane, follow steps 1 and 2 in Opening the Amazon WorkDocs Drive
workdocs-ug-011	workdocs-ug.pdf	11	tools to search for ﬁles stored on Amazon WorkDocs Drive. Reconnecting after working oﬄine 30 Amazon WorkDocs Note Remember that a WorkDocs Drive search is case sensitive. User Guide To search Amazon WorkDocs Drive in Windows Do one of the following: • In Windows File Explorer, right-click the Amazon WorkDocs Drive icon, point to Amazon WorkDocs Drive, choose Search, then enter a search term. • Open the Amazon WorkDocs Drive task pane and enter a term in the search box. If you don't remember how to open the pane, follow steps 1 and 2 in Opening the Amazon WorkDocs Drive settings. To search Amazon WorkDocs Drive on a Macintosh Do one of the following: • On the menu bar, choose the WorkDocs icon and enter a search term. • Start Finder, and under Favorites, right-click the Amazon WorkDocs Drive icon. You can search for ﬁles in all folders, or narrow your search to the My Documents or Shared With Me folders. Deleting ﬁles from Amazon WorkDocs Drive Amazon WorkDocs Drive only contains links to the ﬁles on your WorkDocs site. WorkDocs Drive displays the following icon to indicate the ﬁles' location: When you delete a ﬁle from WorkDocs Drive, you only delete the link to that ﬁle. When you delete a link, WorkDocs moves the corresponding ﬁle to the Recycle bin on your web site. To free up space in WorkDocs Drive, you empty the bin on your WorkDocs web site. Deleting ﬁles from Amazon WorkDocs Drive 31 Amazon WorkDocs To delete ﬁles in WorkDocs Drive User Guide 1. 2. Start Finder (on a Mac) or File Explorer (in Windows) and expand your W: drive. Select the ﬁle or ﬁles that you want to delete. 3. Press Delete. —or— Drag the ﬁles to another location on your hard drive. To empty the Recycle bin in WorkDocs 1. Navigate to WorkDocs in your browser, and in the breadcrumbs above your list of ﬁles and folders, choose Recycle bin. 2. Do one of the following: a. b. To delete all the ﬁles in the bin, choose Empty recycle bin. To delete some of the ﬁles, select the checkbox next to the ﬁles that you want to delete, then choose Delete (N), where N is the number of ﬁles that you selected. Quitting Amazon WorkDocs Drive You quit running Amazon WorkDocs Drive for a number of reasons, such as low network bandwidth, or you don't want to risk unauthorized people getting into your ﬁles. Do one of the following: To quit Amazon WorkDocs Drive in Windows 1. Open the Amazon WorkDocs Drive settings. Open the Amazon WorkDocs Drive settings. If you don't remember how, see Opening the Amazon WorkDocs Drive settings. 2. Choose Quit. To quit Amazon WorkDocs Drive on a Macintosh 1. Go to the menu bar and choose the Amazon WorkDocs Drive icon. Quitting Amazon WorkDocs Drive 32 Amazon WorkDocs 2. Choose Quit. User Guide Restarting Amazon WorkDocs Drive after you quit To restart Amazon WorkDocs Drive after you quit, do one of the following. • On a PC, choose Start to open your list of programs, choose the Amazon folder, then choose Amazon WorkDocs Drive. • On a Mac, go to the menu bar and choose Amazon WorkDocs Drive. Troubleshooting Amazon WorkDocs Drive The following sections provide troubleshooting tips for common Amazon WorkDocs Drive errors. Choose a section to expand it. Critical Dependency Unavailable Restart the Message Queuing service on your computer by opening the Services app. For Message Queuing, choose Restart or Start. If the error persists, open Computer Management, Services and Applications. If Message Queuing does not appear in the navigation pane, uninstall Message Queuing and Amazon WorkDocs Drive. When you reinstall Amazon WorkDocs Drive, it reinstalls Message Queuing for you. For more help, contact your administrator. Drive Repair Required Windows – Restart by opening the Amazon WorkDocs Drive settings and choosing Log out (change site). Repeat those steps to sign in again, and then check the Recovered Files folder for any ﬁles you might need to save. If you don't remember how to open the settings, see Opening the Amazon WorkDocs Drive settings. macOS – Restart Amazon WorkDocs Drive by choosing the Amazon WorkDocs Drive icon on the menu bar, choosing the gear icon, then choosing Log out. Repeat those steps to sign in again, and then check the Recovered Files folder for any ﬁles you might need to save. Restarting Amazon WorkDocs Drive after you quit 33 Amazon WorkDocs User Guide Kernel extensions version mismatch If you use a Mac, you may see the following Version Mismatch notiﬁcation when you try to launch WorkDocs Drive: This happens when a WorkDocs Drive update uses a new kernel extension. Follow these steps to ﬁx the issue. To ﬁx the mismatch 1. Restart your machine. This unloads the current
workdocs-ug-012	workdocs-ug.pdf	12	the menu bar, choosing the gear icon, then choosing Log out. Repeat those steps to sign in again, and then check the Recovered Files folder for any ﬁles you might need to save. Restarting Amazon WorkDocs Drive after you quit 33 Amazon WorkDocs User Guide Kernel extensions version mismatch If you use a Mac, you may see the following Version Mismatch notiﬁcation when you try to launch WorkDocs Drive: This happens when a WorkDocs Drive update uses a new kernel extension. Follow these steps to ﬁx the issue. To ﬁx the mismatch 1. Restart your machine. This unloads the current extension. 2. Try to start Amazon WorkDocs Drive. Your OS blocks the new kernel extension and prompts you to allow it. 3. Go to System Preferences, then Security and Privacy, and allow the extension. Troubleshooting Amazon WorkDocs Drive 34 Amazon WorkDocs User Guide 4. Restart your machine. This loads the new kernel extension. 5. Start Amazon WorkDocs Drive. Local Disk Full Delete unnecessary ﬁles from your local disk and Recovered Files folder. Recovered Files If you change a ﬁle that you don't have permissions to edit, you can't upload that ﬁle to your Amazon WorkDocs site. Instead, the site saves the changes to your local Recovered Files folder. You can open this folder from the Amazon WorkDocs Drive menu by choosing the question mark icon, then Go to recovery folder. From there, you can upload the ﬁle to Amazon WorkDocs as a new ﬁle. Recovery Folder Full Delete unnecessary ﬁles from your local Recovered Files folder. Storage Limit Exceeded Delete unused ﬁles to free up storage space. If you need more space after deleting unused ﬁles, contact your Amazon WorkDocs administrator. Troubleshooting Amazon WorkDocs Drive 35 Amazon WorkDocs User Guide Newer version already installed Follow these steps: To ﬁx the error 1. Remove your current version of Amazon WorkDocs Drive For more information, see Uninstalling Amazon WorkDocs Drive. 2. Restart your machine. 3. Install Amazon WorkDocs Drive. For more information, see Installing Amazon WorkDocs Drive. Reporting issues You use the Amazon WorkDocs Drive task pane to report issues. The following steps explain how. To report an issue 1. Open the Amazon WorkDocs Drive task pane. If you don't remember how, see steps 1 and 2 in Opening the Amazon WorkDocs Drive settings. 2. Choose the question mark icon, and then choose Report an issue to send us a description of the problem. Note the tracking number. It serves as a reference for support cases or correspondence with us. Known limitations Amazon WorkDocs Drive doesn't support Symlinks. Reporting issues 36 Amazon WorkDocs User Guide Working with ﬁles The following topics explain how to work with ﬁles in the Amazon WorkDocs web client and mobile application. Note The web client allows you to do more with ﬁles than the mobile app. For example, you can only use the web client to move ﬁles. In the web client, you use the following items to work with ﬁles. • The Create menu: • The Actions list, and the buttons next to it: In the Amazon WorkDocs mobile app, you use the ellipsis menu at the top of each ﬁle icon: Important You must install Amazon WorkDocs Companion to complete some of the tasks listed in this section. For example, you can't upload or download ﬁles without Companion. For more information about installing and using Companion, see Using Amazon WorkDocs Companion. Topics • Naming ﬁles • Creating ﬁles • Opening ﬁles 37 User Guide Amazon WorkDocs • Uploading ﬁles • Downloading ﬁles • Downloading Word documents with feedback • Marking ﬁles as favorites • Requesting approvals for ﬁles • Changing ﬁle settings • Locking and unlocking ﬁles • Renaming ﬁles • Moving ﬁles • Transferring ﬁle ownership • Deleting ﬁles • Viewing ﬁle activity • Sharing ﬁles • Editing ﬁles • Viewing ﬁles oﬄine • Using smart search • Managing the recycle bin (web only) Naming ﬁles Before you create ﬁles in Amazon WorkDocs you need to know how to name them. Incorrect characters in ﬁle names can cause your Amazon WorkDocs administrator several problems. For example, your administrator can't migrate your data to a faster server or a diﬀerent user group. Here's a list of what to look for and avoid. • Trailing spaces – For example: an extra space at the end of a ﬁle name. • Periods at the beginning or end – For example: .file, .file.ppt, ., .., or file. • Tildes at the beginning or end – For example: file.doc~, ~file.doc, or ~$file.doc • File names ending in .tmp – For example: file.tmp • File names exactly matching these case-sensitive terms – Microsoft User Data, Outlook files, Thumbs.db, or Thumbnails Naming ﬁles 38 Amazon WorkDocs User Guide • File names containing any of these characters – * (asterisk), / (forward
workdocs-ug-013	workdocs-ug.pdf	13	of what to look for and avoid. • Trailing spaces – For example: an extra space at the end of a ﬁle name. • Periods at the beginning or end – For example: .file, .file.ppt, ., .., or file. • Tildes at the beginning or end – For example: file.doc~, ~file.doc, or ~$file.doc • File names ending in .tmp – For example: file.tmp • File names exactly matching these case-sensitive terms – Microsoft User Data, Outlook files, Thumbs.db, or Thumbnails Naming ﬁles 38 Amazon WorkDocs User Guide • File names containing any of these characters – * (asterisk), / (forward slash), \ (back slash), : (colon), < (less than), > (greater than), ? (question mark), \| (vertical bar/pipe), " (double quotes), or \202E (character code 202E). Creating ﬁles The following steps explain how to create ﬁles in Amazon WorkDocs. You can create documents, spreadsheets, and presentations. By default, Amazon WorkDocs creates Microsoft Word, Excel, and PowerPoint ﬁles. If you have Hancom ThinkFree, all new ﬁles open in that application. You can only create ﬁles in the Amazon WorkDocs web client To create ﬁles 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. Choose Create, and on the menu that appears, choose one of the following: • Document – Creates a Word document in the docx format. • Spreadsheet – Creates an Excel spreadsheet in the xlsx format. • Presentation – Creates a PowerPoint slide deck in the pptx format. Note The Folder command also appears on the menu. For information about creating and using folders, see Working with folders. Opening ﬁles The following steps explain how to open ﬁles in the Amazon WorkDocs web client and mobile app. To open ﬁles in the web client 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Choose the ﬁle name. —OR— Creating ﬁles 39 Amazon WorkDocs User Guide Select the check box next to the ﬁle name, open the Actions menu, and then choose Open. To open ﬁles in the mobile app • Choose the ﬁle's icon. Uploading ﬁles The following steps explain how use the Amazon WorkDocs web client to upload ﬁles. When you use the Amazon WorkDocs web client up upload ﬁles, you use File Explorer in Windows or Finder in macOS to select and open the ﬁles. You can also drag them from File Explorer or Finder and drop them on the WorkDocs screen. To upload ﬁles 1. In the web client, choose Upload, and then Upload ﬁles. If you run Wndows, File Explorer appears. If you run macOS, Finder appears. In File Explorer or Finder, select the ﬁles that you want to upload, then choose Open. In the dialog box that appears, select the ﬁles that you want to upload, and then choose Open. 2. 3. To upload ﬁles by dragging and dropping 1. As needed, open the folder that you want to store the ﬁles in. 2. In the web client, choose Upload, and then Upload ﬁles. Uploading ﬁles 40 Amazon WorkDocs User Guide 3. In File Explorer or Finder, select the ﬁles that you want to upload, and then drag them to the WorkDocs screen. Note The following steps assume that you have a local ﬁle with multiple versions. To upload a new version of a ﬁle 1. In the web client, open the ﬁle. 2. Open the Actions menu and choose Upload new version. 3. In File Explorer or Finder, select the version, then choose Open. Downloading ﬁles The following steps explain how to download ﬁles from the Amazon WorkDocs web client. You download single ﬁles, or download them in bulk. You can only perform this action in the web client. To download ﬁles 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Select the check boxes next to the ﬁles that you want to download. 3. Open the Actions menu and choose Download. On a Windows machine, the New Folder dialog box appears and displays the folder's contents. On a macOS machine, Finder appears and does the same. Downloading ﬁles 41 Amazon WorkDocs Note User Guide On a PC, downloaded ﬁles land by default in Downloads/WorkDocsDownloads/folder name. On a Macintosh, downloaded ﬁles land by default in the Hard Drive Name/Users/User Name/WorkDocsDownloads. Downloading Word documents with feedback You can download Microsoft Word documents and any comments added by yourself or other Amazon WorkDocs users. To download ﬁles and feedback 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Open the document ﬁle that you want to download. 3. Open the Actions list, point to Download, and on the menu that appears, choose Download with comments. Note On a PC, downloaded ﬁles land by default in Downloads/WorkDocsDownloads/folder name. On
workdocs-ug-014	workdocs-ug.pdf	14	default in Downloads/WorkDocsDownloads/folder name. On a Macintosh, downloaded ﬁles land by default in the Hard Drive Name/Users/User Name/WorkDocsDownloads. Downloading Word documents with feedback You can download Microsoft Word documents and any comments added by yourself or other Amazon WorkDocs users. To download ﬁles and feedback 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Open the document ﬁle that you want to download. 3. Open the Actions list, point to Download, and on the menu that appears, choose Download with comments. Note On a PC, downloaded ﬁles land by default in Downloads/WorkDocsDownloads/folder name. On a Macintosh, downloaded ﬁles land by default in the Hard Drive Name/Users/User Name/WorkDocsDownloads. Marking ﬁles as favorites Marking ﬁles as favorites makes them easier to ﬁnd. To mark a ﬁle as a favorite in the web client 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Do one of the following: Downloading Word documents with feedback 42 Amazon WorkDocs User Guide • Choose the star icon next to the desired folder. —OR— Select the check box next to the desired folder, open the Actions list, and then choose Favorite. To mark a folder as a favorite in the mobile app • Choose the ellipsis at the top of the folder, and then choose Favorite. Requesting approvals for ﬁles The steps in this section explain how to request approvals for Amazon WorkDocs ﬁles. Remember the following: • You can only use the web client to request approvals. • You use the Amazon WorkDocs Approvals app to create and work with approval requests. You can start the app automatically after you choose a ﬁle, or you can start it manually. The steps in this section explain both methods. • You can request approvals from individual users, or from one or more groups of users. Note This section only explains how to create approval requests. For information about responding to, updating, and canceling requests, see Working with approvals. To create an approval request automatically Note These steps explain how to request approval for one ﬁle. If you need approvals for multiple ﬁles, follow the steps for creating approval requests manually. Requesting approvals for ﬁles 43 Amazon WorkDocs User Guide 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Select the check box next to the ﬁle that you want to have approved. 3. Open the Actions list and choose Request Approval. The Approvals app opens in a new browser tab. 4. Under Group 1, enter the names or email addresses of your approvers. You can only use the names or addresses of users in your Amazon WorkDocs organization. 5. Select one of the following: • Anyone can approve – Any individual approver in this group can approve on behalf of the group. • Everyone must approve – Every approver in this group must approve. • (Optional) Choose Due date, and then use the calendar control to select a due date for the approvals. • (Optional) Choose Add Group, and then repeat the previous step and this step to add a group of approvers. The system sends the approval request to each group in the order that you create them. 6. Choose Next, and then do the following:. • Under Title, enter a title. • (Optional) Under Description, enter a description. 7. Choose Next, review the approval request, and then do one of the following: • Choose Back to go back and make changes. • Choose Send to send the request. To create an approval request manually 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. In the web client, choose Apps. The Approvals page appears. 3. Under Approvals, choose Launch. The Amazon WorkDocs Approvals app opens in a new browser tab. 4. Choose Create Approval. Requesting approvals for ﬁles 44 Amazon WorkDocs User Guide 5. Choose Add Files, and select the ﬁle or ﬁles that you want to have approved. 6. Choose Done, and then choose Next. 7. Complete steps 3 through 6 in the previous procedure to create and send the request. Changing ﬁle settings You change ﬁle settings when you need to: You also use the command to lock and unlock ﬁles, and for more information about that, see • Enable or disable ﬁle downloads and user feedback. • Lock and unlock ﬁles. The following steps explain how to change the settings for downloads and user feedback. For information about locking ﬁles, see Locking and unlocking ﬁles To change settings 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. Select the check box next to the ﬁle that you want to change. You can only select one ﬁle at a time. 3. Open the
workdocs-ug-015	workdocs-ug.pdf	15	also use the command to lock and unlock ﬁles, and for more information about that, see • Enable or disable ﬁle downloads and user feedback. • Lock and unlock ﬁles. The following steps explain how to change the settings for downloads and user feedback. For information about locking ﬁles, see Locking and unlocking ﬁles To change settings 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. Select the check box next to the ﬁle that you want to change. You can only select one ﬁle at a time. 3. Open the Actions list and choose Settings. 4. Select or clear the Allow Downloads and Allow feedback buttons. Locking and unlocking ﬁles Locking a ﬁle prevents others from overwriting your work. Remember the following about locking ﬁles. • Owners, co-owners, and contributors can lock ﬁles and send requests to unlock a ﬁle. Owners and co-owners can also unlock any locked ﬁles. • Contributors can unlock a ﬁle only if they locked it • Only the person who locks a ﬁle can upload a new version while the ﬁle is locked. Changing ﬁle settings 45 Amazon WorkDocs Note User Guide You can only use the web client to lock and unlock ﬁles. You can't use the mobile app or Amazon WorkDocs Drive. To lock a ﬁle 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. Select the check box next to the ﬁle that you want to lock. —OR— Open the ﬁle that you want to lock. 3. Open the Actions, choose Settings and then choose Lock. 4. A lock icon appears next to the ﬁle. If you locked a ﬁle, you can unlock it when you're done. To unlock a ﬁle • Open the ﬁle and choose the lock icon. The lock icon disappears, and you can work on the ﬁle. You can unlock a ﬁle that someone else locked, but you must be a co-owner to do so. To unlock a ﬁle that you co-own 1. Open the ﬁle. 2. Choose the lock icon. When you aren't a co-owner of a ﬁle, and you need to edit that ﬁle, you can send an unlock request to the user who locked it. Locking and unlocking ﬁles 46 Amazon WorkDocs To send an unlock request User Guide 1. Select the check box for ﬁle that you want to unlock. 2. Open the Actions list, choose Settings, and then choose Request unlock. Amazon WorkMail sends the request to the user who locked the ﬁle, the ﬁle owner, and any co-owners. Renaming ﬁles You can rename ﬁles if you have the ownership role for those ﬁles. For more information about roles, see Permissions. Important Make sure your ﬁle names only contain allowed characters. For information about characters to avoid, see Naming ﬁles. To rename a ﬁle 1. In the web client, select the check box next to the ﬁle you want to rename. Note Just select the check box. Choosing the ﬁle opens it Preview mode, and that disables the Rename command. 2. 3. For Actions, choose More, Rename. Enter the new name, then press Enter. Moving ﬁles You can move ﬁles if you have the ownership role for those ﬁles. For more information about roles, see Permissions. To move ﬁles Renaming ﬁles 47 Amazon WorkDocs To move a ﬁle User Guide 1. In the web client, select the check box next to the ﬁle that you want to move. Note Just select the check box. Choosing the ﬁle name opens the ﬁle in Preview mode, and that disables the commands for renaming and moving. 2. 3. For Actions, choose More, Move. In the dialog box, navigate to the target folder and choose Move. Note Moving a folder also moves the ﬁles and sub-folders within the folder. To move multiple ﬁles at the same time, move them into a folder, and then move that folder. Transferring ﬁle ownership You can request a transfer of ownership for any ﬁles that you own. Remember the following: • • Transfers remove ownership from you and grant it to a user that you specify. • The speciﬁed user must accept ownership. You retain ownership until the other user accepts. Note System administrators can transfer an inactive user's ﬁles and folders to an active user. For more information, see Transferring document ownership in the Amazon WorkDocs Administration Guide. To transfer ﬁle ownership 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. Transferring ﬁle ownership 48 Amazon WorkDocs User Guide 2. On your My Docs page, select the check box next to the item that you want to transfer. Note Don't select the folder name. Doing so opens the folder in Preview mode and
workdocs-ug-016	workdocs-ug.pdf	16	ownership. You retain ownership until the other user accepts. Note System administrators can transfer an inactive user's ﬁles and folders to an active user. For more information, see Transferring document ownership in the Amazon WorkDocs Administration Guide. To transfer ﬁle ownership 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. Transferring ﬁle ownership 48 Amazon WorkDocs User Guide 2. On your My Docs page, select the check box next to the item that you want to transfer. Note Don't select the folder name. Doing so opens the folder in Preview mode and disables the Transfer command. Just select the check boxes. 3. Open the Actions list and choose Transfer. The Transfer Resource Ownership dialog box appears. 4. In the search box, enter the name of the new owner. If the search returns multiple names, choose the correct recipient. 5. Choose Transfer. The new owner receives a task under My Tasks in Amazon WorkDocs. After the new owner accepts the ﬁles, they appear on that owner's My Docs page. Deleting ﬁles You can use the web client or the mobile app to delete ﬁles. When you delete a ﬁle, Amazon WorkDocs moves it to the recycle bin. To delete ﬁles in the web client 1. In the web client, select the ﬁles you want to delete. 2. Open the Actions list, choose More, and then choose Delete. To delete ﬁles in the mobile app 1. Choose the ellipsis above the ﬁle that you want to delete. 2. Choose Delete. Viewing ﬁle activity In the Amazon WorkDocs web client, you can view the activities taken on a ﬁle, including its creation date, who viewed the ﬁle, and the date when someone downloaded the ﬁle. For more information, see Tracking ﬁle activity. Deleting ﬁles 49 Amazon WorkDocs Sharing ﬁles User Guide You follow the same steps for sharing ﬁles and folders. For more information, see Sharing ﬁles and folders. Editing ﬁles The steps in this section explain how to edit ﬁles in Amazon WorkDocs. You can only edit ﬁles in the web client. If you haven't installed Amazon WorkDocs Companion, the system prompts you to do so the ﬁrst time you edit a ﬁle. From there, you can edit ﬁles on your desktop. When you save your changes, Amazon WorkDocs saves them as a new ﬁle version. To edit a ﬁle 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. Do one of the following: • Open the ﬁle that you want to edit. The ﬁle appears in Amazon WorkDocs. • Select the check box next to the ﬁle name. 3. Choose Edit, and then choose Companion App. Note If your site administrator has enabled a collaborative editing feature, such as Microsoft Oﬃce Online, you can select that option to edit your ﬁle. For more information, see Feedback and collaborative editing. 4. If Amazon WorkDocs Companion isn’t installed, follow the prompts to install it. 5. After installing Amazon WorkDocs Companion, the ﬁle opens on your computer desktop for editing. Choose whether to lock the ﬁle while you edit it. 6. When you’re done editing, choose Save to automatically save your changes to Amazon WorkDocs as a new ﬁle version. If you lock the ﬁle, you can unlock it when you're done with your changes. For more information about locking and unlocking ﬁles, see Locking and unlocking ﬁles. Sharing ﬁles 50 Amazon WorkDocs User Guide For more information about Amazon WorkDocs Companion, see Using Amazon WorkDocs Companion. Viewing ﬁles oﬄine To view ﬁles oﬄine, use Amazon WorkDocs Drive. For more information, see Using Amazon WorkDocs Drive. If you are using Amazon WorkDocs on your Android or iOS device, you can download any ﬁle that you are authorized to by viewing the document and choosing the download icon. This makes oﬄine ﬁles available on your device. Once you download a ﬁle, the download icon changes to a dark background. To view your oﬄine ﬁles, choose Oﬄine Documents in the app. You can give feedback on a document even when oﬄine. Your feedback is synchronized to the server the next time you have Internet access. Using smart search Amazon WorkDocs smart search looks for search terms in all ﬁles that you have permissions for. By default, it searches ﬁle names, metadata, comments, labels, user names, and ﬁle owners. It also searches content within text-searchable ﬁles, such as Word, Excel, PowerPoint, PDF, .txt, JavaScript, and other code ﬁles. Choose the Advanced search option to view and select available search ﬁlters. To use Amazon WorkDocs smart search 1. In the Amazon WorkDocs web application, for Search, enter a partial or complete search term. a. Optionally, enter the AND or OR operators. b. Optionally, enclose the search term in quotation marks (for
workdocs-ug-017	workdocs-ug.pdf	17	WorkDocs smart search looks for search terms in all ﬁles that you have permissions for. By default, it searches ﬁle names, metadata, comments, labels, user names, and ﬁle owners. It also searches content within text-searchable ﬁles, such as Word, Excel, PowerPoint, PDF, .txt, JavaScript, and other code ﬁles. Choose the Advanced search option to view and select available search ﬁlters. To use Amazon WorkDocs smart search 1. In the Amazon WorkDocs web application, for Search, enter a partial or complete search term. a. Optionally, enter the AND or OR operators. b. Optionally, enclose the search term in quotation marks (for example, "search term") to limit search results to that exact search term. 2. Do one of the following: • Press Enter. • Choose Advanced to select search ﬁlters such as Locations, Time, or Resource Types, and then choose Search. 3. The search results appear in the web application. Viewing ﬁles oﬄine 51 Amazon WorkDocs User Guide Managing the recycle bin (web only) You use the web client to manage your Recycle bin. To delete ﬁles from the Recycle bin 1. 2. In the web client, choose Recycle bin. Select the ﬁles to delete, and choose Delete. 3. Amazon WorkDocs deletes the ﬁles permanently. To restore ﬁles from the Recycle bin 1. 2. 3. In the web client, choose Recycle bin. Select the ﬁles to restore, and choose Restore. The restored ﬁles appear in MyDocs. Managing the recycle bin (web only) 52 Amazon WorkDocs User Guide Working with ﬁle versions The topics in this section explain how to work with ﬁle versions. Amazon WorkDocs supports unlimited versions of a ﬁle. The versions preserve your ﬁles' change histories. Each version includes all content and any feedback. You can only use the Amazon WorkDocs web client to view and use past versions of a ﬁle. Topics • Understanding when Amazon WorkDocs creates versions • How versions impact your storage limit • Deleting previous versions of a ﬁle • Reducing the number of Amazon WorkDocs Drive versions • Using past versions of a ﬁle • Reverting a ﬁle to a previous version Understanding when Amazon WorkDocs creates versions As a rule, Amazon WorkDocs creates ﬁle versions when you overwrite a ﬁle or save changes to a ﬁle. However, that process varies, depending on where you are and what you do with a ﬁle. From the Amazon WorkDocs web client When you upload a ﬁle to the web client, and that ﬁle already exists in the same folder, the uploaded ﬁle becomes the new version. Also, when you preview a ﬁle in the web client, and you then drag any ﬁle from your local drive and drop it onto the previewed ﬁle, the dropped ﬁle becomes the new version. From Amazon WorkDocs Companion If you edit a ﬁle while using Companion, Amazon WorkDocs creates a new version each time you save the ﬁle. From Amazon WorkDocs Drive When you edit a ﬁle stored in Amazon WorkDocs Drive the system creates a new version every 30 seconds while you edit. Understanding version creation 53 Amazon WorkDocs Note User Guide Amazon WorkDocs Drive can create versions of large ﬁles that consume a lot of your storage space. For information on how to reduce the amount of storage, see the next section. How versions impact your storage limit Your Amazon WorkDocs subscription includes a certain amount of cloud storage space, and ﬁle versions count toward that limit. The amount of space depends on your subscription. If you exceed your limit, you can ask your Amazon WorkDocs site administrator for more space. AWS bills you for the additional space. For more information about storage limits and rates, see the WorkDocs Pricing page. Deleting previous versions of a ﬁle If you own or co-own a ﬁle, you can delete one or more previous versions of that ﬁle. You can: • Delete a single version. • Delete a version and all prior versions. For example, you can keep the last three versions of a ﬁle and delete the rest. • Delete all prior versions and only keep the latest version. Important To recover deleted ﬁles, you must use the Amazon WorkDocs application programming interfaces (APIs). For issues using the APIs, contact Amazon WorkDocs customer support. You can use the vX of X list or the Actions menu to delete previous versions. Steps in the following sections explain each method. How versions impact your storage limit 54 Amazon WorkDocs User Guide Using the v X of X list to delete versions To delete a single version 1. In the Amazon WorkDocs web client, select the checkbox next to the ﬁle that contains the version or versions you want to delete. The ﬁle's title appears just below the menu bar, along with a list control that reads vX of X. Note If only
workdocs-ug-018	workdocs-ug.pdf	18	Amazon WorkDocs customer support. You can use the vX of X list or the Actions menu to delete previous versions. Steps in the following sections explain each method. How versions impact your storage limit 54 Amazon WorkDocs User Guide Using the v X of X list to delete versions To delete a single version 1. In the Amazon WorkDocs web client, select the checkbox next to the ﬁle that contains the version or versions you want to delete. The ﬁle's title appears just below the menu bar, along with a list control that reads vX of X. Note If only one version of a ﬁle exists, the list control doesn't appear. 2. Open the list, scroll down to the version that you want to delete, and then choose the Trash icon. 3. In the Conﬁrm Document Version Deletion dialog box, choose Delete It. To delete a selected version and previous versions 1. Repeat steps 1 and 2 in the procedure above. 2. In the Conﬁrm Document Version Deletion dialog box, choose the Delete the selected and all previous versions checkbox. 3. Choose Delete It. To delete all previous versions 1. Repeat steps 1 and 2 in the ﬁrst procedure above, but select the most recent previous version. For example, select version 14 of 15. 2. In the Conﬁrm Document Version Deletion dialog box, choose the Delete the selected and all previous versions checkbox. 3. Choose Delete It. Deleting previous versions of a ﬁle 55 Amazon WorkDocs User Guide Using the Actions menu to delete versions To delete a single version 1. In the Amazon WorkDocs web client, select the checkbox next to the ﬁle that contains the version or versions you want to delete. The ﬁle's title appears just below the menu bar, along with a list control that reads vX of X. Note If only one version of a ﬁle exists, the list control doesn't appear. 2. Open the list and choose the version that you want to delete. 3. Open the Actions menu. 4. Choose More. 5. Choose Delete Version. 6. In the Conﬁrm Document Version Deletion dialog box, choose Delete It. To delete a selected version and previous versions 1. Repeat steps 1 through 5 in the procedure above. 2. In the Conﬁrm Document Version Deletion dialog box, choose the Delete the selected and all previous versions checkbox. 3. Choose Delete It. To delete all previous versions 1. Repeat steps 1 and 2 in the ﬁrst procedure above, but select the most recent previous version. For example, select version 14 of 15. 2. Open the Actions menu. 3. Choose More. 4. Choose Delete Version. Deleting previous versions of a ﬁle 56 Amazon WorkDocs User Guide 5. In the Conﬁrm Document Version Deletion dialog box, choose the Delete the selected and all previous versions checkbox. 6. Choose Delete It. Reducing the number of Amazon WorkDocs Drive versions For greater safety and convenience, Amazon WorkDocs Drive stores all versions of a ﬁle, and it automatically creates new versions of the ﬁle every 30 seconds while you modify the ﬁle. If you download large ﬁles directly to Amazon WorkDocs Drive, and the download time exceeds 30 seconds, the system creates multiple versions of those big ﬁles. To prevent those unwanted versions, download the ﬁles to a local folder, and then copy them from there to Amazon WorkDocs Drive. For existing ﬁles with multiple versions, you can delete the ﬁles from Amazon WorkDocs and upload them from your local drive. That removes the unwanted versions and reclaims the storage space. Using past versions of a ﬁle You can use past versions of a ﬁle like you can any other ﬁle. For example, you can download, lock, share, or edit any version of a ﬁle. Follow these steps. To use a past version of a ﬁle 1. In the web client, open the ﬁle. The ﬁle's title appears just below the menu bar, along with a list control that reads vX of X. Note If only one version of a ﬁle exists, the list control doesn't appear. 2. Open the vX of X list and select the version you want to view. At this point, you can use any of the commands except Create. Reducing the number of Amazon WorkDocs Drive versions 57 Amazon WorkDocs User Guide Reverting a ﬁle to a previous version You can revert a ﬁle to a previous version at any time. To revert a ﬁle 1. In the web client, open the ﬁle. The ﬁle's title appears just below the menu bar, along with a list control that reads vX of X. Note If only one version of a ﬁle exists, the list control doesn't appear. 2. Open the vX of X list and select the version that you want to revert to. 3. Choose Edit, choose
workdocs-ug-019	workdocs-ug.pdf	19	except Create. Reducing the number of Amazon WorkDocs Drive versions 57 Amazon WorkDocs User Guide Reverting a ﬁle to a previous version You can revert a ﬁle to a previous version at any time. To revert a ﬁle 1. In the web client, open the ﬁle. The ﬁle's title appears just below the menu bar, along with a list control that reads vX of X. Note If only one version of a ﬁle exists, the list control doesn't appear. 2. Open the vX of X list and select the version that you want to revert to. 3. Choose Edit, choose the appropriate editor for the ﬁle, such as Companion App, then choose Yes to lock the ﬁle. 4. 5. In the editor, save the ﬁle to your local drive. If prompted, overwrite the existing ﬁle. In Amazon WorkDocs open the Actions list and choose Upload new version. The Open dialog box appears. 6. Open the ﬁle that you saved in step 4. Amazon WorkDocs uploads and locks the ﬁle. You need to unlock the ﬁle to edit it. For more information about locking and unlocking ﬁles, see Locking and unlocking ﬁles. Reverting a ﬁle to a previous version 58 Amazon WorkDocs User Guide Working with folders The following topics explain how to work with folders in the Amazon WorkDocs web client and mobile application. Note The web client allows you to do more with folders than the mobile app. For example, you can only use the web client to download or move folders. In the web client, you use the following items to work with folders. • The Create menu: • The Actions list, and the buttons next to it: In the Amazon WorkDocs mobile app, you use the ellipsis menu at the top of each folder: Important You must install Amazon WorkDocs Companion to complete some of the tasks listed in this section. For example, you can't upload or download folders without Companion. For more information about installing and using Companion, see Using Amazon WorkDocs Companion. Contents • Creating folders • Opening folders 59 User Guide Amazon WorkDocs • Duplicating folders • Downloading folders • Marking folders as favorites • Requesting approvals for folders • Renaming folders • Moving folders • Transferring folder ownership • Deleting folders • Viewing folder activity • Sharing folders • Uploading folders • Managing the recycle bin (web only) Creating folders You can only create folders in the Amazon WorkDocs web client. You can create the following types of folders: • Individual folders. You can keep individual folders for your own use, or share them with other users in your Amazon WorkDocs organization. • Team folders. You create a team folder by inviting your team directory group to share the folder. If you don't have a team directory group, ask your Amazon WorkDocs site administrator to create one. Your administrator is the person who invited you to join Amazon WorkDocs. You can create folders in these locations: • Your MyDocs folder. • In the folders that you create in your My Docs folder. • In folders that others share with you, if you have owner or co-owner permissions to the shared folders. Creating folders 60 Amazon WorkDocs Note User Guide As you create sub-folders, remember that Amazon WorkDocs only displays the ﬁrst 260 characters of a folder path. To create a folder 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. Make sure you're in the correct location for the new folder. 3. Open the Create menu and choose Folder. The Create Folder dialog box appears. 4. Enter a name for the folder, and then choose Create. Note Be careful when entering folder names. Using characters such as periods (.) and tildes (~) prevents your administrator from migrating your folders. As a result, you may ﬁnd your data on a slower server, or your data may not be available if you move to a diﬀerent Amazon WorkDocs group. For more information, see Naming ﬁles To create a sub folder 1. In the Amazon WorkDocs web client, open the folder that will contain the sub folder. 2. Open the Create menu and choose Folder. 3. Enter a name for the sub folder, and then choose Create. To create a team folder 1. 2. Follow the previous steps to create a folder. Send an invitation to share the folder with your team directory group. For more information on sharing folders by invitation, see Sharing by invitation. Your team members will have the permissions that you set when you create the invitation. Creating folders 61 Amazon WorkDocs Opening folders User Guide Amazon WorkDocs provides the following ways to open folders. • In the web client or the mobile app, choose the folder name. • In the web client,
workdocs-ug-020	workdocs-ug.pdf	20	a name for the sub folder, and then choose Create. To create a team folder 1. 2. Follow the previous steps to create a folder. Send an invitation to share the folder with your team directory group. For more information on sharing folders by invitation, see Sharing by invitation. Your team members will have the permissions that you set when you create the invitation. Creating folders 61 Amazon WorkDocs Opening folders User Guide Amazon WorkDocs provides the following ways to open folders. • In the web client or the mobile app, choose the folder name. • In the web client, select the check box next to the folder that you want to open, and from the Actions list, choose Open. A list of any ﬁles and any sub-folders appears. Duplicating folders The Amazon WorkDocs web client doesn't provide a command for duplicating folders. However, if you use Amazon WorkDocs Drive, you can create a copy of a folder, and that copy appears in the web client. For information about copying folders, see Duplicating folders. For information about installing Amazon WorkDocs Drive see Using Amazon WorkDocs Drive. Downloading folders Note You must have Amazon WorkDocs Companion to follow the steps in this topic. The following steps explain how to download folders from the Amazon WorkDocs web client. Downloading a folder also downloads everything in the folder. You can only perform this action in the web client. To download folders 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Select the check boxes next to the folders that you want to download. —OR— To download one or more sub-folders, open the parent folder, and then select the check boxes next to the sub-folders that you want to download. Opening folders 62 Amazon WorkDocs Note User Guide Just select the check box or boxes. Choosing a folder name opens the folder in Preview mode, and that disables the Download command. 3. Open the Actions menu and choose Download. On a Windows machine, the New Folder dialog box appears and displays the folder's contents. On a macOS machine, Finder appears and does the same. Note On a PC, downloaded folders land by default in Downloads/WorkDocsDownloads/folder name. On a Macintosh, downloaded folders land by default in the Hard Drive Name/Users/User Name/WorkDocsDownloads. Marking folders as favorites Marking a folder as a favorite can help you ﬁnd items that you use frequently. To mark a folder as a favorite in the web client 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Do one of the following: • Choose the star icon next to the desired folder. —OR— Select the check box next to the desired folder, open the Actions list, and then choose Favorite. To mark a folder as a favorite in the mobile app • Choose the ellipsis at the top of the folder, and then choose Favorite. Marking folders as favorites 63 Amazon WorkDocs User Guide Requesting approvals for folders The steps in this section explain how to request approvals for a Amazon WorkDocs folder. Remember the following: • You can only use the web client to request approvals. • You use the Amazon WorkDocs Approvals app to create and work with approval requests. You can start the app automatically after you choose a folder, or you can start it manually. The steps in this section explain both methods. • You can request approvals from individual users, or from one or more groups of users. Note This section only explains how to create approval requests. For information about responding to, updating, and canceling requests, see Working with approvals. To create an approval request automatically Note These steps allow you to request approval for one folder. If you need approvals for multiple folders, follow the steps for creating approval requests manually. 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Select the check box next to the folder that you want to have approved. 3. Open the Actions list and choose Request Approval. The Approvals app opens in a new browser tab. 4. Under Group 1, enter the names or email addresses of your approvers. You can only use the names or addresses of users in your Amazon WorkDocs organization. 5. Select one of the following: • Anyone can approve – Any individual approver in this group can approve on behalf of the group. Requesting approvals for folders 64 Amazon WorkDocs User Guide • Everyone must approve – Every approver in this group must approve. • (Optional) Choose Due date, and then use the calendar control to select a due date for the approvals. • (Optional) Choose Add Group, and then repeat the previous step and this step to add a group of approvers. The system sends
workdocs-ug-021	workdocs-ug.pdf	21	only use the names or addresses of users in your Amazon WorkDocs organization. 5. Select one of the following: • Anyone can approve – Any individual approver in this group can approve on behalf of the group. Requesting approvals for folders 64 Amazon WorkDocs User Guide • Everyone must approve – Every approver in this group must approve. • (Optional) Choose Due date, and then use the calendar control to select a due date for the approvals. • (Optional) Choose Add Group, and then repeat the previous step and this step to add a group of approvers. The system sends the approval request to each group in the order that you create them. 6. Choose Next, and then do the following:. • Under Title, enter a title. • (Optional) Under Description, enter a description. 7. Choose Next, review the approval request, and then do one of the following: • Choose Back to go back and make changes. • Choose Send to send the request. To create an approval request manually 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. In the web client, choose Apps. The Approvals page appears. 3. Under Approvals, choose Launch. The Amazon WorkDocs Approvals app opens in a new browser tab. 4. Choose Create Approval. 5. Choose Add Files, and select the folder or folders for the approval request. 6. Choose Done, and then choose Next. 7. Complete steps 3 through 6 in the previous procedure to create and send the request. Renaming folders You can rename folders if you have the ownership role for those folders. For more information about roles, see Permissions. Renaming folders 65 Amazon WorkDocs User Guide To rename a folder in the web client 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. Select the check box next to the folder you want to rename. Note Just select the check box. Choosing the ﬁle or folder name opens the folder in Preview mode, and that disables the Rename command. 3. Open the Actions list, choose More, and then choose Rename. 4. Enter the new name, and then press Enter. To rename a folder in the mobile app 1. Use the credentials provided by your administrator to log in to Amazon WorkDocs. 2. Choose the ellipsis menu for the folder you want to rename, and then choose Rename. The Rename dialog box appears. 3. Enter the new name for the folder, and then press OK. Moving folders You can move folders in the web client if you have the ownership role for those folders. For more information about roles, see Permissions. To move a folder 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. In the web client, select the check box next to the folder you want to move. Note Just select the check box. Choosing the folder name opens the folder in Preview mode, and that disables the Move command. Moving folders 66 Amazon WorkDocs User Guide 3. Open the Actions list, choose More, and then choose Move. 4. In the dialog box, navigate to the target folder and choose Move. Note Moving a folder also moves the ﬁles and sub-folders within the folder. To move multiple ﬁles at the same time, move them into a folder, and then move that folder. Transferring folder ownership You can request a transfer of ownership for any folders that you own. Remember the following: • Transferring a folder automatically transfers ownership of all the ﬁles in that folder. • Transfers remove ownership from you and grant it to a user that you specify. • The speciﬁed user must accept ownership. You retain ownership until the other user accepts. Note System administrators can transfer an inactive user's ﬁles and folders to an active user. For more information, see Transferring document ownership in the Amazon WorkDocs Administration Guide. To transfer ownership folders 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. On your My Docs page, select the check box next to the folder that you want to transfer. Note Don't select the folder name. Doing so opens the folder in Preview mode and disables the Transfer command. Just select the check boxes. 3. Open the Actions list and choose Transfer. Transferring folder ownership 67 Amazon WorkDocs User Guide The Transfer Resource Ownership dialog box appears. 4. In the search box, enter the name of the new owner. If the search returns multiple names, choose the correct recipient. 5. Choose Transfer. The new owner receives a task under My Tasks in Amazon WorkDocs. After the new owner accepts the ﬁles, they appear on that owner's My Docs page. Deleting folders When you
workdocs-ug-022	workdocs-ug.pdf	22	the folder name. Doing so opens the folder in Preview mode and disables the Transfer command. Just select the check boxes. 3. Open the Actions list and choose Transfer. Transferring folder ownership 67 Amazon WorkDocs User Guide The Transfer Resource Ownership dialog box appears. 4. In the search box, enter the name of the new owner. If the search returns multiple names, choose the correct recipient. 5. Choose Transfer. The new owner receives a task under My Tasks in Amazon WorkDocs. After the new owner accepts the ﬁles, they appear on that owner's My Docs page. Deleting folders When you delete a folder, Amazon WorkDocs moves it to the recycle bin. If a folder contains other ﬁles or folders, they go to the recycle bin as well. To delete folders in the web client 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. Select the check box next to the folder that you want to delete. Note Just select the check box. Choosing the folder name opens the folder in Preview mode, and that disables the Delete command. 3. Open the Actions list, choose More, and then choose Delete. To delete folders in the mobile app 1. Choose the ellipsis menu above the folder that you want to delete. 2. Choose Delete. Viewing folder activity In the Amazon WorkDocs web client, you can view the activities taken on a folder, including its creation date, and the date when you or someone else renamed the folder. For more information, see Tracking ﬁle activity. Deleting folders 68 Amazon WorkDocs Sharing folders User Guide You follow the same steps for sharing ﬁles and folders. For more information, see Sharing ﬁles and folders. Uploading folders The following steps explain how to upload folders to Amazon WorkDocs If you run Windows, you can use Amazon WorkDocs Companion with File Explorer to upload multiple folders. For more information, see Using Amazon WorkDocs Companion. To upload folders 1. Use the credentials provided by your administrator to log in to the Amazon WorkDocs web client. 2. In the web client, choose Upload, and then Upload folder. On a Windows machine, the Select ﬁle to upload dialog box appears. On a Mac, Finder appears. 3. Select the folder or folders that you want to upload, and then choose Upload. Managing the recycle bin (web only) You use the web client to manage your Recycle bin. To delete folders from the Recycle bin 1. 2. In the web client, choose Recycle bin. Select the folders to delete, and then choose Delete. 3. Amazon WorkDocs deletes the folders permanently. To restore folders from the Recycle bin 1. 2. 3. In the web client, choose Recycle bin. Select the folders to restore, and then choose Restore. The restored ﬁles appear in MyDocs. Sharing folders 69 Amazon WorkDocs User Guide Sharing ﬁles and folders You can share ﬁles and folders with other users, inside and outside of your organization. You can share by inviting other users, or by emailing links to ﬁles or folders. When you share by invitation, you can choose which permissions the user has. For more information about permissions, see Permissions. You can also revoke permissions, and users can remove themselves from a shared item. Note You can only share with directory groups, not email distribution lists. Topics • Sharing link • Sharing by invitation • Removing share permissions • Removing yourself from a share Sharing link If your site administrator enables link sharing, you can share your Amazon WorkDocs ﬁles and folders by sharing links them. You can share ﬁle links inside and outside your organization, but you can only share folder links internally. In addition, you can conﬁgure a ﬁle link to allow access to site members only, or to anyone on the internet. Site members can view, comment on, update, or delete a ﬁle. Public links only allow viewing. You can also set an expiration date and a 4-digit passcode for access to the ﬁle. If you don't see the commands listed in the following steps, ask your administrator to enable link sharing. To share a link 1. In the web client, select the ﬁle or folder to share. Sharing link 70 Amazon WorkDocs 2. Choose Share, Share a link. User Guide 3. Under Link access level, select the desired access level. Options: • Oﬀ – No access is allowed. • View – View only access is allowed to anyone inside your Amazon WorkDocs organization. • View and edit – View and edit access is allowed to anyone inside your Amazon WorkDocs organization. 4. 5. (Optional) Under Link expiry date, choose the date when the link expires. The link expires at midnight on the speciﬁed date. (Optional) Under Passcode, enter a 4-digit access code that link recipients must
workdocs-ug-023	workdocs-ug.pdf	23	share. Sharing link 70 Amazon WorkDocs 2. Choose Share, Share a link. User Guide 3. Under Link access level, select the desired access level. Options: • Oﬀ – No access is allowed. • View – View only access is allowed to anyone inside your Amazon WorkDocs organization. • View and edit – View and edit access is allowed to anyone inside your Amazon WorkDocs organization. 4. 5. (Optional) Under Link expiry date, choose the date when the link expires. The link expires at midnight on the speciﬁed date. (Optional) Under Passcode, enter a 4-digit access code that link recipients must enter to access the content. 6. Choose Create & Copy. Amazon WorkDocs copies the link to your clipboard for sharing. Sharing by invitation You can invite users and groups to share ﬁles or folders. You can invite users within your organization by default. If your Amazon WorkDocs administrator enables it, you can also share ﬁles and folders with users outside your organization. Inviting people also allows you to set their permissions. If you share a folder, the permissions for that folder apply to all the documents in the folder. To invite people to share ﬁles or folders 1. In the web client, select the ﬁle or folder that you want to share. 2. Choose Share, then Invite people. Sharing by invitation 71 Amazon WorkDocs User Guide 3. To invite people in your organization, in the Invite speciﬁc people box, enter the name of the person or group with whom you want to share, then select the desired name from the list of results. —OR— To invite people outside your organization, enter the email address of the person or group with whom you want to share. When you ﬁnish, the address appears in a pop-up. Select that pop-up to add the address to your list of users. Note Sharing invitations do not include members of nested groups. To include those members, you must add them to the Share by Invite list. 4. Select the desired permissions for the folder or ﬁle. Co-Owner These users and groups can rename and delete ﬁles, and share the ﬁle or ﬁles in the folder with others. Contributor The default permission level. These users and groups can provide feedback on the ﬁle or ﬁles in the folder. Viewer These users and groups can only view the ﬁle or ﬁles in the folder. They cannot provide feedback. External users have Viewer as the default permission, and this can't be changed unless they are converted from a Guest to regular User by an administrator. Sharing by invitation 72 Amazon WorkDocs User Guide 5. Optionally, choose Add personal message to enter your own message to the people you're inviting. 6. Choose from the following options: • If you're sharing a folder, choose whether to make it read-only. If you don't, users can upload new ﬁles or new versions of existing ﬁles to the folder. • If you're sharing a ﬁle, choose Request feedback to ask for feedback. You can also set deadlines for feedback requests. Note You can only request feedback for ﬁles, not folders, and you can only request feedback from users, not groups. 7. Choose Save. Amazon WorkDocs sends an email to the invitees notifying them of the shared ﬁle or folder. The email includes a link to the ﬁle or folder, any personal message, and the feedback deadline, if you speciﬁed one. If you receive an error message saying that you can't share a document with people outside of your organization, your Amazon WorkDocs administrator hasn't authorized you to share externally. Contact that administrator for assistance. Removing share permissions If you are the owner or co-owner of a folder or ﬁle, you can remove users or groups from the share permissions. To remove share permissions 1. In the web client, select the folder or ﬁle. 2. Open the Share menu, and then choose Permissions. Removing share permissions 73 Amazon WorkDocs User Guide The Permissions pane appears and displays the names of the users or groups that share the document. 3. For Access, choose the dropdown menu next to the user or group that you want to remove, and then choose Remove. 4. Choose OK. The system removes the user or group from the Permissions list immediately. Removing yourself from a share After someone shares a ﬁle or folder with you, you can remove yourself from the share. To remove yourself from a share 1. In the web client, select the shared ﬁle or folder. 2. Do one of the following: Removing yourself from a share 74 Amazon WorkDocs User Guide • Choose Actions, Remove me from share, then Yes, remove me. • For Share, choose Permissions. For Access, choose the dropdown menu next to your name, and choose Remove, OK. WorkDocs removes you from the Permissions

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.