AWS SDK for PHP 3.x (original) (raw)

The resource does not exist.

The specified document version is not in the INITIALIZED state.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

The resource hierarchy is changing.

ActivateUser

result=result = result=client->activateUser([/* ... /]); promise=promise = promise=client->activateUserAsync([/ ... */]);

Activates the specified user. Only active users can access Amazon WorkDocs.

Parameter Syntax

result=result = result=client->activateUser([ 'AuthenticationToken' => '', 'UserId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

UserId

Required: Yes

Type: string

The ID of the user.

Result Syntax

Result Details

Members

User

The user information.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

AddResourcePermissions

result=result = result=client->addResourcePermissions([/* ... /]); promise=promise = promise=client->addResourcePermissionsAsync([/ ... */]);

Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

Parameter Syntax

result=result = result=client->addResourcePermissions([ 'AuthenticationToken' => '', 'NotificationOptions' => [ 'EmailMessage' => '', 'SendEmail' => true || false, ], 'Principals' => [ // REQUIRED [ 'Id' => '', // REQUIRED 'Role' => 'VIEWER|CONTRIBUTOR|OWNER|COOWNER', // REQUIRED 'Type' => 'USER|GROUP|INVITE|ANONYMOUS|ORGANIZATION', // REQUIRED ], // ... ], 'ResourceId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

NotificationOptions

Type: NotificationOptions structure

The notification options.

Principals

Required: Yes

Type: Array of SharePrincipal structures

The users, groups, or organization being granted permission.

ResourceId

Required: Yes

Type: string

The ID of the resource.

Result Syntax

[ 'ShareResults' => [ [ 'InviteePrincipalId' => '', 'PrincipalId' => '', 'Role' => 'VIEWER|CONTRIBUTOR|OWNER|COOWNER', 'ShareId' => '', 'Status' => 'SUCCESS|FAILURE', 'StatusMessage' => '', ], // ... ], ]

Result Details

Members

ShareResults

Type: Array of ShareResult structures

The share results.

Errors

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

The specified document version is not in the INITIALIZED state. result=result = result=client->createComment([/* ... /]); promise=promise = promise=client->createCommentAsync([/ ... */]);

Adds a new comment to the specified document version.

Parameter Syntax

result=result = result=client->createComment([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED 'NotifyCollaborators' => true || false, 'ParentId' => '', 'Text' => '', // REQUIRED 'ThreadId' => '', 'VersionId' => '', // REQUIRED 'Visibility' => 'PUBLIC|PRIVATE', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

NotifyCollaborators

Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

ParentId

The ID of the parent comment.

Text

Required: Yes

Type: string

The text of the comment.

ThreadId

The ID of the root comment in the thread.

VersionId

Required: Yes

Type: string

The ID of the document version.

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.

Result Syntax

Result Details

Members

Comment

The comment that has been created.

Errors

The resource does not exist.

The specified document version is not in the INITIALIZED state.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

DocumentLockedForCommentsException:

One or more of the dependencies is unavailable.

This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

InvalidCommentOperationException:

The requested operation is not allowed on the specified comment object.

CreateCustomMetadata

result=result = result=client->createCustomMetadata([/* ... /]); promise=promise = promise=client->createCustomMetadataAsync([/ ... */]);

Adds one or more custom properties to the specified resource (a folder, document, or version).

Parameter Syntax

result=result = result=client->createCustomMetadata([ 'AuthenticationToken' => '', 'CustomMetadata' => ['', ...], // REQUIRED 'ResourceId' => '', // REQUIRED 'VersionId' => '', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

CustomMetadata

Required: Yes

Type: Associative array of custom strings keys (CustomMetadataKeyType) to strings

Custom metadata in the form of name-value pairs.

ResourceId

Required: Yes

Type: string

The ID of the resource.

VersionId

The ID of the version, if the custom metadata is being added to a document version.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

CustomMetadataLimitExceededException:

The specified document version is not in the INITIALIZED state.

The limit has been reached on the number of custom properties for the specified resource.

The 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.

One or more of the dependencies is unavailable.

CreateFolder

result=result = result=client->createFolder([/* ... /]); promise=promise = promise=client->createFolderAsync([/ ... */]);

Creates a folder with the specified name and parent folder.

Parameter Syntax

result=result = result=client->createFolder([ 'AuthenticationToken' => '', 'Name' => '', 'ParentFolderId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Name

The name of the new folder.

ParentFolderId

Required: Yes

Type: string

The ID of the parent folder.

Result Syntax

[ 'Metadata' => [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionSize' => , 'ModifiedTimestamp' => , 'Name' => '', 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', 'Signature' => '', 'Size' => , ], ]

Result Details

Members

Metadata

Type: FolderMetadata structure

The metadata of the folder.

Errors

The resource does not exist.

The resource already exists.

The specified document version is not in the INITIALIZED state.

Another operation is in progress on the resource that conflicts with the current operation.

The resource hierarchy is changing.

The maximum of 100,000 files and folders under the parent folder has been exceeded.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

CreateLabels

result=result = result=client->createLabels([/* ... /]); promise=promise = promise=client->createLabelsAsync([/ ... */]);

Adds the specified list of labels to the given resource (a document or folder)

Parameter Syntax

result=result = result=client->createLabels([ 'AuthenticationToken' => '', 'Labels' => ['', ...], // REQUIRED 'ResourceId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Labels

Required: Yes

Type: Array of strings

List of labels to add to the resource.

ResourceId

Required: Yes

Type: string

The ID of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

TooManyLabelsException:

One or more of the dependencies is unavailable.

The limit has been reached on the number of labels for the specified resource.

CreateNotificationSubscription

result=result = result=client->createNotificationSubscription([/* ... /]); promise=promise = promise=client->createNotificationSubscriptionAsync([/ ... */]);

Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

For more information, see Setting up notifications for an IAM user or role in the Amazon WorkDocs Developer Guide.

Parameter Syntax

result=result = result=client->createNotificationSubscription([ 'Endpoint' => '', // REQUIRED 'OrganizationId' => '', // REQUIRED 'Protocol' => 'HTTPS|SQS', // REQUIRED 'SubscriptionType' => 'ALL', // REQUIRED ]);

Parameter Details

Members

Endpoint

Required: Yes

Type: string

The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.

OrganizationId

Required: Yes

Type: string

The ID of the organization.

Protocol

Required: Yes

Type: string

The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

SubscriptionType

Required: Yes

Type: string

The notification type.

Result Syntax

[ 'Subscription' => [ 'EndPoint' => '', 'Protocol' => 'HTTPS|SQS', 'SubscriptionId' => '', ], ]

Result Details

Members

Subscription

Type: Subscription structure

The subscription.

Errors

TooManySubscriptionsException:

The caller does not have access to perform the action on the resource.

You've reached the limit on the number of subscriptions for the WorkDocs instance.

One or more of the dependencies is unavailable.

The pagination marker or limit fields are not valid.

CreateUser

result=result = result=client->createUser([/* ... /]); promise=promise = promise=client->createUserAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->createUser([ 'AuthenticationToken' => '', 'EmailAddress' => '', 'GivenName' => '', // REQUIRED 'OrganizationId' => '', 'Password' => '', // REQUIRED 'StorageRule' => [ 'StorageAllocatedInBytes' => , 'StorageType' => 'UNLIMITED|QUOTA', ], 'Surname' => '', // REQUIRED 'TimeZoneId' => '', 'Username' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

EmailAddress

The email address of the user.

GivenName

Required: Yes

Type: string

The given name of the user.

OrganizationId

The ID of the organization.

Password

Required: Yes

Type: string

The password of the user.

StorageRule

Type: StorageRuleType structure

The amount of storage for the user.

Surname

Required: Yes

Type: string

The surname of the user.

TimeZoneId

The time zone ID of the user.

Username

Required: Yes

Type: string

The login name of the user.

Result Syntax

Result Details

Members

User

The user information.

Errors

The resource already exists.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

DeactivateUser

result=result = result=client->deactivateUser([/* ... /]); promise=promise = promise=client->deactivateUserAsync([/ ... */]);

Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

Parameter Syntax

result=result = result=client->deactivateUser([ 'AuthenticationToken' => '', 'UserId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

UserId

Required: Yes

Type: string

The ID of the user.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable. result=result = result=client->deleteComment([/* ... /]); promise=promise = promise=client->deleteCommentAsync([/ ... */]);

Deletes the specified comment from the document version.

Parameter Syntax

result=result = result=client->deleteComment([ 'AuthenticationToken' => '', 'CommentId' => '', // REQUIRED 'DocumentId' => '', // REQUIRED 'VersionId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

CommentId

Required: Yes

Type: string

The ID of the comment.

DocumentId

Required: Yes

Type: string

The ID of the document.

VersionId

Required: Yes

Type: string

The ID of the document version.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The specified document version is not in the INITIALIZED state.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

DocumentLockedForCommentsException:

One or more of the dependencies is unavailable.

This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

DeleteCustomMetadata

result=result = result=client->deleteCustomMetadata([/* ... /]); promise=promise = promise=client->deleteCustomMetadataAsync([/ ... */]);

Deletes custom metadata from the specified resource.

Parameter Syntax

result=result = result=client->deleteCustomMetadata([ 'AuthenticationToken' => '', 'DeleteAll' => true || false, 'Keys' => ['', ...], 'ResourceId' => '', // REQUIRED 'VersionId' => '', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DeleteAll

Flag to indicate removal of all custom metadata properties from the specified resource.

Keys

List of properties to remove.

ResourceId

Required: Yes

Type: string

The ID of the resource, either a document or folder.

VersionId

The ID of the version, if the custom metadata is being deleted from a document version.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The specified document version is not in the INITIALIZED state.

The 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.

One or more of the dependencies is unavailable.

DeleteDocument

result=result = result=client->deleteDocument([/* ... /]); promise=promise = promise=client->deleteDocumentAsync([/ ... */]);

Permanently deletes the specified document and its associated metadata.

Parameter Syntax

result=result = result=client->deleteDocument([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The maximum of 100,000 files and folders under the parent folder has been exceeded.

The specified document version is not in the INITIALIZED state.

Another operation is in progress on the resource that conflicts with the current operation.

The resource hierarchy is changing.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

DeleteDocumentVersion

result=result = result=client->deleteDocumentVersion([/* ... /]); promise=promise = promise=client->deleteDocumentVersionAsync([/ ... */]);

Deletes a specific version of a document.

Parameter Syntax

result=result = result=client->deleteDocumentVersion([ 'AuthenticationToken' => '', 'DeletePriorVersions' => true || false, // REQUIRED 'DocumentId' => '', // REQUIRED 'VersionId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DeletePriorVersions

Required: Yes

Type: boolean

Deletes all versions of a document prior to the current version.

DocumentId

Required: Yes

Type: string

The ID of the document associated with the version being deleted.

VersionId

Required: Yes

Type: string

The ID of the version being deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The specified document version is not in the INITIALIZED state.

Another operation is in progress on the resource that conflicts with the current operation.

The resource hierarchy is changing.

The caller does not have access to perform the action on the resource.

InvalidOperationException:

The 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.

The operation is invalid.

The operation is not permitted.

DeleteFolder

result=result = result=client->deleteFolder([/* ... /]); promise=promise = promise=client->deleteFolderAsync([/ ... */]);

Permanently deletes the specified folder and its contents.

Parameter Syntax

result=result = result=client->deleteFolder([ 'AuthenticationToken' => '', 'FolderId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

FolderId

Required: Yes

Type: string

The ID of the folder.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The maximum of 100,000 files and folders under the parent folder has been exceeded.

The specified document version is not in the INITIALIZED state.

Another operation is in progress on the resource that conflicts with the current operation.

The resource hierarchy is changing.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

DeleteFolderContents

result=result = result=client->deleteFolderContents([/* ... /]); promise=promise = promise=client->deleteFolderContentsAsync([/ ... */]);

Deletes the contents of the specified folder.

Parameter Syntax

result=result = result=client->deleteFolderContents([ 'AuthenticationToken' => '', 'FolderId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

FolderId

Required: Yes

Type: string

The ID of the folder.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The specified document version is not in the INITIALIZED state.

Another operation is in progress on the resource that conflicts with the current operation.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

DeleteLabels

result=result = result=client->deleteLabels([/* ... /]); promise=promise = promise=client->deleteLabelsAsync([/ ... */]);

Deletes the specified list of labels from a resource.

Parameter Syntax

result=result = result=client->deleteLabels([ 'AuthenticationToken' => '', 'DeleteAll' => true || false, 'Labels' => ['', ...], 'ResourceId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DeleteAll

Flag to request removal of all labels from the specified resource.

Labels

List of labels to delete from the resource.

ResourceId

Required: Yes

Type: string

The ID of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

The specified document version is not in the INITIALIZED state.

DeleteNotificationSubscription

result=result = result=client->deleteNotificationSubscription([/* ... /]); promise=promise = promise=client->deleteNotificationSubscriptionAsync([/ ... */]);

Deletes the specified subscription from the specified organization.

Parameter Syntax

result=result = result=client->deleteNotificationSubscription([ 'OrganizationId' => '', // REQUIRED 'SubscriptionId' => '', // REQUIRED ]);

Parameter Details

Members

OrganizationId

Required: Yes

Type: string

The ID of the organization.

SubscriptionId

Required: Yes

Type: string

The ID of the subscription.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The caller does not have access to perform the action on the resource.

The resource does not exist.

One or more of the dependencies is unavailable.

The specified document version is not in the INITIALIZED state.

DeleteUser

result=result = result=client->deleteUser([/* ... /]); promise=promise = promise=client->deleteUserAsync([/ ... */]);

Deletes the specified user from a Simple AD or Microsoft AD directory.

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.

Parameter Syntax

result=result = result=client->deleteUser([ 'AuthenticationToken' => '', 'UserId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using Amazon Web Services credentials.

UserId

Required: Yes

Type: string

The ID of the user.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

DescribeActivities

result=result = result=client->describeActivities([/* ... /]); promise=promise = promise=client->describeActivitiesAsync([/ ... */]);

Describes the user activities in a specified time period.

Parameter Syntax

result=result = result=client->describeActivities([ 'ActivityTypes' => '', 'AuthenticationToken' => '', 'EndTime' => <integer || string || DateTime>, 'IncludeIndirectActivities' => true || false, 'Limit' => , 'Marker' => '', 'OrganizationId' => '', 'ResourceId' => '', 'StartTime' => <integer || string || DateTime>, 'UserId' => '', ]);

Parameter Details

Members

ActivityTypes

Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

EndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

IncludeIndirectActivities

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.

Marker

The marker for the next set of results.

OrganizationId

The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

ResourceId

The document or folder ID for which to describe activity types.

StartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified 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.

Result Syntax

[ 'Marker' => '', 'UserActivities' => [ [ 'CommentMetadata' => [ 'CommentId' => '', 'CommentStatus' => 'DRAFT|PUBLISHED|DELETED', 'Contributor' => [ 'CreatedTimestamp' => , 'EmailAddress' => '', 'GivenName' => '', 'Id' => '', 'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default', 'ModifiedTimestamp' => , 'OrganizationId' => '', 'RecycleBinFolderId' => '', 'RootFolderId' => '', 'Status' => 'ACTIVE|INACTIVE|PENDING', 'Storage' => [ 'StorageRule' => [ 'StorageAllocatedInBytes' => , 'StorageType' => 'UNLIMITED|QUOTA', ], 'StorageUtilizedInBytes' => , ], 'Surname' => '', 'TimeZoneId' => '', 'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER', 'Username' => '', ], 'ContributorId' => '', 'CreatedTimestamp' => , 'RecipientId' => '', ], 'Initiator' => [ 'EmailAddress' => '', 'GivenName' => '', 'Id' => '', 'Surname' => '', 'Username' => '', ], 'IsIndirectActivity' => true || false, 'OrganizationId' => '', 'OriginalParent' => [ 'Id' => '', 'Name' => '', 'OriginalName' => '', 'Owner' => [ 'EmailAddress' => '', 'GivenName' => '', 'Id' => '', 'Surname' => '', 'Username' => '', ], 'ParentId' => '', 'Type' => 'FOLDER|DOCUMENT', 'VersionId' => '', ], 'Participants' => [ 'Groups' => [ [ 'Id' => '', 'Name' => '', ], // ... ], 'Users' => [ [ 'EmailAddress' => '', 'GivenName' => '', 'Id' => '', 'Surname' => '', 'Username' => '', ], // ... ], ], 'ResourceMetadata' => [ 'Id' => '', 'Name' => '', 'OriginalName' => '', 'Owner' => [ 'EmailAddress' => '', 'GivenName' => '', 'Id' => '', 'Surname' => '', 'Username' => '', ], 'ParentId' => '', 'Type' => 'FOLDER|DOCUMENT', 'VersionId' => '', ], 'TimeStamp' => , 'Type' => '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', ], // ... ], ]

Result Details

Members

Marker

The marker for the next set of results.

UserActivities

Type: Array of Activity structures

The list of activities for the specified user and time period.

Errors

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The pagination marker or limit fields are not valid.

The 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.

One or more of the dependencies is unavailable. result=result = result=client->describeComments([/* ... /]); promise=promise = promise=client->describeCommentsAsync([/ ... */]);

List all the comments for the specified document version.

Parameter Syntax

result=result = result=client->describeComments([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED 'Limit' => , 'Marker' => '', 'VersionId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

Limit

The maximum number of items to return.

Marker

The marker for the next set of results. This marker was received from a previous call.

VersionId

Required: Yes

Type: string

The ID of the document version.

Result Syntax

Result Details

Members

Comments

Type: Array of Comment structures

The list of comments for the specified document version.

Marker

The marker for the next set of results. This marker was received from a previous call.

Errors

The resource does not exist.

The specified document version is not in the INITIALIZED state.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

DescribeDocumentVersions

result=result = result=client->describeDocumentVersions([/* ... /]); promise=promise = promise=client->describeDocumentVersionsAsync([/ ... */]);

Retrieves the document versions for the specified document.

By default, only active versions are returned.

Parameter Syntax

result=result = result=client->describeDocumentVersions([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED 'Fields' => '', 'Include' => '', 'Limit' => , 'Marker' => '', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

Fields

Specify "SOURCE" to include initialized versions and a URL for the source document.

Include

A comma-separated list of values. Specify "INITIALIZED" to include incomplete versions.

Limit

The maximum number of versions to return with this call.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

Result Syntax

[ 'DocumentVersions' => [ [ 'ContentCreatedTimestamp' => , 'ContentModifiedTimestamp' => , 'ContentType' => '', 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'ModifiedTimestamp' => , 'Name' => '', 'Signature' => '', 'Size' => , 'Source' => ['', ...], 'Status' => 'INITIALIZED|ACTIVE', 'Thumbnail' => ['', ...], ], // ... ], 'Marker' => '', ]

Result Details

Members

DocumentVersions

Type: Array of DocumentVersionMetadata structures

The document versions.

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The pagination marker or limit fields are not valid.

The 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.

One or more of the dependencies is unavailable.

The specified document version is not in the INITIALIZED state.

The password is invalid.

DescribeFolderContents

result=result = result=client->describeFolderContents([/* ... /]); promise=promise = promise=client->describeFolderContentsAsync([/ ... */]);

Describes the contents of the specified folder, including its documents and subfolders.

By default, Amazon WorkDocs returns the first 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.

Parameter Syntax

result=result = result=client->describeFolderContents([ 'AuthenticationToken' => '', 'FolderId' => '', // REQUIRED 'Include' => '', 'Limit' => , 'Marker' => '', 'Order' => 'ASCENDING|DESCENDING', 'Sort' => 'DATE|NAME', 'Type' => 'ALL|DOCUMENT|FOLDER', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

FolderId

Required: Yes

Type: string

The ID of the folder.

Include

The contents to include. Specify "INITIALIZED" to include initialized documents.

Limit

The maximum number of items to return with this call.

Marker

The marker for the next set of results. This marker was received from a previous call.

Order

The order for the contents of the folder.

Sort

The sorting criteria.

Type

The type of items.

Result Syntax

[ 'Documents' => [ [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionMetadata' => [ 'ContentCreatedTimestamp' => , 'ContentModifiedTimestamp' => , 'ContentType' => '', 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'ModifiedTimestamp' => , 'Name' => '', 'Signature' => '', 'Size' => , 'Source' => ['', ...], 'Status' => 'INITIALIZED|ACTIVE', 'Thumbnail' => ['', ...], ], 'ModifiedTimestamp' => , 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', ], // ... ], 'Folders' => [ [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionSize' => , 'ModifiedTimestamp' => , 'Name' => '', 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', 'Signature' => '', 'Size' => , ], // ... ], 'Marker' => '', ]

Result Details

Members

Documents

Type: Array of DocumentMetadata structures

The documents in the specified folder.

Folders

Type: Array of FolderMetadata structures

The subfolders in the specified folder.

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Errors

The resource does not exist.

The caller does not have access to perform the action on the resource.

The pagination marker or limit fields are not valid.

The 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.

One or more of the dependencies is unavailable.

The specified document version is not in the INITIALIZED state.

DescribeGroups

result=result = result=client->describeGroups([/* ... /]); promise=promise = promise=client->describeGroupsAsync([/ ... */]);

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

Parameter Syntax

result=result = result=client->describeGroups([ 'AuthenticationToken' => '', 'Limit' => , 'Marker' => '', 'OrganizationId' => '', 'SearchQuery' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Limit

The maximum number of items to return with this call.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

OrganizationId

The ID of the organization.

SearchQuery

Required: Yes

Type: string

A query to describe groups by group name.

Result Syntax

[ 'Groups' => [ [ 'Id' => '', 'Name' => '', ], // ... ], 'Marker' => '', ]

Result Details

Members

Groups

Type: Array of GroupMetadata structures

The list of groups.

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Errors

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

DescribeNotificationSubscriptions

result=result = result=client->describeNotificationSubscriptions([/* ... /]); promise=promise = promise=client->describeNotificationSubscriptionsAsync([/ ... */]);

Lists the specified notification subscriptions.

Parameter Syntax

result=result = result=client->describeNotificationSubscriptions([ 'Limit' => , 'Marker' => '', 'OrganizationId' => '', // REQUIRED ]);

Parameter Details

Members

Limit

The maximum number of items to return with this call.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

OrganizationId

Required: Yes

Type: string

The ID of the organization.

Result Syntax

[ 'Marker' => '', 'Subscriptions' => [ [ 'EndPoint' => '', 'Protocol' => 'HTTPS|SQS', 'SubscriptionId' => '', ], // ... ], ]

Result Details

Members

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Subscriptions

Type: Array of Subscription structures

The subscriptions.

Errors

The caller does not have access to perform the action on the resource.

The resource does not exist.

One or more of the dependencies is unavailable.

DescribeResourcePermissions

result=result = result=client->describeResourcePermissions([/* ... /]); promise=promise = promise=client->describeResourcePermissionsAsync([/ ... */]);

Describes the permissions of a specified resource.

Parameter Syntax

result=result = result=client->describeResourcePermissions([ 'AuthenticationToken' => '', 'Limit' => , 'Marker' => '', 'PrincipalId' => '', 'ResourceId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Limit

The maximum number of items to return with this call.

Marker

The marker for the next set of results. (You received this marker from a previous call)

PrincipalId

The ID of the principal to filter permissions by.

ResourceId

Required: Yes

Type: string

The ID of the resource.

Result Syntax

Result Details

Members

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Principals

Type: Array of Principal structures

The principals.

Errors

The pagination marker or limit fields are not valid.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

DescribeRootFolders

result=result = result=client->describeRootFolders([/* ... /]); promise=promise = promise=client->describeRootFoldersAsync([/ ... */]);

Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files 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.

Parameter Syntax

result=result = result=client->describeRootFolders([ 'AuthenticationToken' => '', // REQUIRED 'Limit' => , 'Marker' => '', ]);

Parameter Details

Members

AuthenticationToken

Required: Yes

Type: string

Amazon WorkDocs authentication token.

Limit

The maximum number of items to return.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

Result Syntax

[ 'Folders' => [ [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionSize' => , 'ModifiedTimestamp' => , 'Name' => '', 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', 'Signature' => '', 'Size' => , ], // ... ], 'Marker' => '', ]

Result Details

Members

Folders

Type: Array of FolderMetadata structures

The user's special folders.

Marker

The marker for the next set of results.

Errors

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The pagination marker or limit fields are not valid.

The 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.

One or more of the dependencies is unavailable.

DescribeUsers

result=result = result=client->describeUsers([/* ... /]); promise=promise = promise=client->describeUsersAsync([/ ... */]);

Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

By default, Amazon WorkDocs returns the first 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.

Parameter Syntax

result=result = result=client->describeUsers([ 'AuthenticationToken' => '', 'Fields' => '', 'Include' => 'ALL|ACTIVE_PENDING', 'Limit' => , 'Marker' => '', 'Order' => 'ASCENDING|DESCENDING', 'OrganizationId' => '', 'Query' => '', 'Sort' => 'USER_NAME|FULL_NAME|STORAGE_LIMIT|USER_STATUS|STORAGE_USED', 'UserIds' => '', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Fields

A comma-separated list of values. Specify "STORAGE_METADATA" to include the user storage quota and utilization information.

Include

The state of the users. Specify "ALL" to include inactive users.

Limit

The maximum number of items to return.

Marker

The marker for the next set of results. (You received this marker from a previous call.)

Order

The order for the results.

OrganizationId

The ID of the organization.

Query

A query to filter 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 user names that match a corresponding user ID.
The Query parameter runs a "prefix" search for users by the GivenName, SurName, or UserName fields 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.

Sort

The sorting criteria.

UserIds

The IDs of the users.

Result Syntax

Result Details

Members

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

TotalNumberOfUsers

The total number of users included in the results.

Users

Type: Array of User structures

The users.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

RequestedEntityTooLargeException:

The pagination marker or limit fields are not valid.

The response is too large to return. The request must include a filter to reduce the size of the response.

GetCurrentUser

result=result = result=client->getCurrentUser([/* ... /]); promise=promise = promise=client->getCurrentUserAsync([/ ... */]);

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

Parameter Syntax

result=result = result=client->getCurrentUser([ 'AuthenticationToken' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Required: Yes

Type: string

Amazon WorkDocs authentication token.

Result Syntax

Result Details

Members

User

Metadata of the user.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

GetDocument

result=result = result=client->getDocument([/* ... /]); promise=promise = promise=client->getDocumentAsync([/ ... */]);

Retrieves details of a document.

Parameter Syntax

result=result = result=client->getDocument([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED 'IncludeCustomMetadata' => true || false, ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

IncludeCustomMetadata

Set this to TRUE to include custom metadata in the response.

Result Syntax

[ 'CustomMetadata' => ['', ...], 'Metadata' => [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionMetadata' => [ 'ContentCreatedTimestamp' => , 'ContentModifiedTimestamp' => , 'ContentType' => '', 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'ModifiedTimestamp' => , 'Name' => '', 'Signature' => '', 'Size' => , 'Source' => ['', ...], 'Status' => 'INITIALIZED|ACTIVE', 'Thumbnail' => ['', ...], ], 'ModifiedTimestamp' => , 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', ], ]

Result Details

Members

CustomMetadata

Type: Associative array of custom strings keys (CustomMetadataKeyType) to strings

The custom metadata on the document.

Metadata

Type: DocumentMetadata structure

The metadata details of the document.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The pagination marker or limit fields are not valid.

The 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.

One or more of the dependencies is unavailable.

The password is invalid.

GetDocumentPath

result=result = result=client->getDocumentPath([/* ... /]); promise=promise = promise=client->getDocumentPathAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->getDocumentPath([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED 'Fields' => '', 'Limit' => , 'Marker' => '', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

Fields

A comma-separated list of values. Specify NAME to include the names of the parent folders.

Limit

The maximum number of levels in the hierarchy to return.

Marker

This value is not supported.

Result Syntax

[ 'Path' => [ 'Components' => [ [ 'Id' => '', 'Name' => '', ], // ... ], ], ]

Result Details

Members

Path

Type: ResourcePath structure

The path information.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

GetDocumentVersion

result=result = result=client->getDocumentVersion([/* ... /]); promise=promise = promise=client->getDocumentVersionAsync([/ ... */]);

Retrieves version metadata for the specified document.

Parameter Syntax

result=result = result=client->getDocumentVersion([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED 'Fields' => '', 'IncludeCustomMetadata' => true || false, 'VersionId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

Fields

A comma-separated list of values. Specify "SOURCE" to include a URL for the source document.

IncludeCustomMetadata

Set this to TRUE to include custom metadata in the response.

VersionId

Required: Yes

Type: string

The version ID of the document.

Result Syntax

[ 'CustomMetadata' => ['', ...], 'Metadata' => [ 'ContentCreatedTimestamp' => , 'ContentModifiedTimestamp' => , 'ContentType' => '', 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'ModifiedTimestamp' => , 'Name' => '', 'Signature' => '', 'Size' => , 'Source' => ['', ...], 'Status' => 'INITIALIZED|ACTIVE', 'Thumbnail' => ['', ...], ], ]

Result Details

Members

CustomMetadata

Type: Associative array of custom strings keys (CustomMetadataKeyType) to strings

The custom metadata on the document version.

Metadata

Type: DocumentVersionMetadata structure

The version metadata.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

The specified document version is not in the INITIALIZED state.

The password is invalid.

GetFolder

result=result = result=client->getFolder([/* ... /]); promise=promise = promise=client->getFolderAsync([/ ... */]);

Retrieves the metadata of the specified folder.

Parameter Syntax

result=result = result=client->getFolder([ 'AuthenticationToken' => '', 'FolderId' => '', // REQUIRED 'IncludeCustomMetadata' => true || false, ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

FolderId

Required: Yes

Type: string

The ID of the folder.

IncludeCustomMetadata

Set to TRUE to include custom metadata in the response.

Result Syntax

[ 'CustomMetadata' => ['', ...], 'Metadata' => [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionSize' => , 'ModifiedTimestamp' => , 'Name' => '', 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', 'Signature' => '', 'Size' => , ], ]

Result Details

Members

CustomMetadata

Type: Associative array of custom strings keys (CustomMetadataKeyType) to strings

The custom metadata on the folder.

Metadata

Type: FolderMetadata structure

The metadata of the folder.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The pagination marker or limit fields are not valid.

The 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.

One or more of the dependencies is unavailable.

The specified document version is not in the INITIALIZED state.

GetFolderPath

result=result = result=client->getFolderPath([/* ... /]); promise=promise = promise=client->getFolderPathAsync([/ ... */]);

Retrieves the path information (the hierarchy from the root folder) for the specified 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.

Parameter Syntax

result=result = result=client->getFolderPath([ 'AuthenticationToken' => '', 'Fields' => '', 'FolderId' => '', // REQUIRED 'Limit' => , 'Marker' => '', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Fields

A comma-separated list of values. Specify "NAME" to include the names of the parent folders.

FolderId

Required: Yes

Type: string

The ID of the folder.

Limit

The maximum number of levels in the hierarchy to return.

Marker

This value is not supported.

Result Syntax

[ 'Path' => [ 'Components' => [ [ 'Id' => '', 'Name' => '', ], // ... ], ], ]

Result Details

Members

Path

Type: ResourcePath structure

The path information.

Errors

The resource does not exist.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

GetResources

result=result = result=client->getResources([/* ... /]); promise=promise = promise=client->getResourcesAsync([/ ... */]);

Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

Parameter Syntax

result=result = result=client->getResources([ 'AuthenticationToken' => '', 'CollectionType' => 'SHARED_WITH_ME', 'Limit' => , 'Marker' => '', 'UserId' => '', ]);

Parameter Details

Members

AuthenticationToken

The Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

CollectionType

The collection type.

Limit

The maximum number of resources to return.

Marker

The marker for the next set of results. This marker was received from a previous call.

UserId

The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

Result Syntax

Result Details

Members

Documents

Type: Array of DocumentMetadata structures

The documents in the specified collection.

Folders

Type: Array of FolderMetadata structures

The folders in the specified folder.

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Errors

The caller does not have access to perform the action on the resource.

The operation is not permitted.

The pagination marker or limit fields are not valid.

The 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.

One or more of the dependencies is unavailable.

InitiateDocumentVersionUpload

result=result = result=client->initiateDocumentVersionUpload([/* ... /]); promise=promise = promise=client->initiateDocumentVersionUploadAsync([/ ... */]);

Creates a new document object and version object.

The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first 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.

Parameter Syntax

result=result = result=client->initiateDocumentVersionUpload([ 'AuthenticationToken' => '', 'ContentCreatedTimestamp' => <integer || string || DateTime>, 'ContentModifiedTimestamp' => <integer || string || DateTime>, 'ContentType' => '', 'DocumentSizeInBytes' => , 'Id' => '', 'Name' => '', 'ParentFolderId' => '', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

ContentCreatedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the content of the document was originally created.

ContentModifiedTimestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

The timestamp when the content of the document was modified.

ContentType

The content type of the document.

DocumentSizeInBytes

The size of the document, in bytes.

The ID of the document.

Name

The name of the document.

ParentFolderId

The ID of the parent folder.

Result Syntax

[ 'Metadata' => [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionMetadata' => [ 'ContentCreatedTimestamp' => , 'ContentModifiedTimestamp' => , 'ContentType' => '', 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'ModifiedTimestamp' => , 'Name' => '', 'Signature' => '', 'Size' => , 'Source' => ['', ...], 'Status' => 'INITIALIZED|ACTIVE', 'Thumbnail' => ['', ...], ], 'ModifiedTimestamp' => , 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', ], 'UploadMetadata' => [ 'SignedHeaders' => ['', ...], 'UploadUrl' => '', ], ]

Result Details

Members

Metadata

Type: DocumentMetadata structure

The document metadata.

UploadMetadata

Type: UploadMetadata structure

The upload metadata.

Errors

The resource does not exist.

StorageLimitExceededException:

The resource already exists.

The storage limit has been exceeded.

StorageLimitWillExceedException:

The storage limit will be exceeded.

The maximum of 100,000 files and folders under the parent folder has been exceeded.

The specified document version is not in the INITIALIZED state.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

DraftUploadOutOfSyncException:

One or more of the dependencies is unavailable.

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.

ResourceAlreadyCheckedOutException:

The resource is already checked out.

The password is invalid.

The pagination marker or limit fields are not valid.

RemoveAllResourcePermissions

result=result = result=client->removeAllResourcePermissions([/* ... /]); promise=promise = promise=client->removeAllResourcePermissionsAsync([/ ... */]);

Removes all the permissions from the specified resource.

Parameter Syntax

result=result = result=client->removeAllResourcePermissions([ 'AuthenticationToken' => '', 'ResourceId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

ResourceId

Required: Yes

Type: string

The ID of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

RemoveResourcePermission

result=result = result=client->removeResourcePermission([/* ... /]); promise=promise = promise=client->removeResourcePermissionAsync([/ ... */]);

Removes the permission for the specified principal from the specified resource.

Parameter Syntax

result=result = result=client->removeResourcePermission([ 'AuthenticationToken' => '', 'PrincipalId' => '', // REQUIRED 'PrincipalType' => 'USER|GROUP|INVITE|ANONYMOUS|ORGANIZATION', 'ResourceId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

PrincipalId

Required: Yes

Type: string

The principal ID of the resource.

PrincipalType

The principal type of the resource.

ResourceId

Required: Yes

Type: string

The ID of the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

RestoreDocumentVersions

result=result = result=client->restoreDocumentVersions([/* ... /]); promise=promise = promise=client->restoreDocumentVersionsAsync([/ ... */]);

Recovers a deleted version of an Amazon WorkDocs document.

Parameter Syntax

result=result = result=client->restoreDocumentVersions([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The specified document version is not in the INITIALIZED state.

Another operation is in progress on the resource that conflicts with the current operation.

The resource hierarchy is changing.

The caller does not have access to perform the action on the resource.

InvalidOperationException:

The 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.

The operation is invalid.

The operation is not permitted.

SearchResources

result=result = result=client->searchResources([/* ... /]); promise=promise = promise=client->searchResourcesAsync([/ ... */]);

Searches metadata and the content of folders, documents, document versions, and comments.

Parameter Syntax

result=result = result=client->searchResources([ 'AdditionalResponseFields' => ['', ...], 'AuthenticationToken' => '', 'Filters' => [ 'AncestorIds' => ['', ...], 'ContentCategories' => ['', ...], 'CreatedRange' => [ 'EndValue' => <integer || string || DateTime>, 'StartValue' => <integer || string || DateTime>, ], 'Labels' => ['', ...], 'ModifiedRange' => [ 'EndValue' => <integer || string || DateTime>, 'StartValue' => <integer || string || DateTime>, ], 'Principals' => [ [ 'Id' => '', // REQUIRED 'Roles' => ['', ...], ], // ... ], 'ResourceTypes' => ['', ...], 'SearchCollectionTypes' => ['', ...], 'SizeRange' => [ 'EndValue' => , 'StartValue' => , ], 'TextLocales' => ['', ...], ], 'Limit' => , 'Marker' => '', 'OrderBy' => [ [ 'Field' => 'RELEVANCE|NAME|SIZE|CREATED_TIMESTAMP|MODIFIED_TIMESTAMP', 'Order' => 'ASC|DESC', ], // ... ], 'OrganizationId' => '', 'QueryScopes' => ['', ...], 'QueryText' => '', ]);

Parameter Details

Members

AdditionalResponseFields

A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Filters

Filters results based on entity metadata.

Limit

Max results count per page.

Marker

The marker for the next set of results.

OrderBy

Type: Array of SearchSortResult structures

Order by results in one or more categories.

OrganizationId

Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.

QueryScopes

Filter based on the text field 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

QueryText

The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.

Result Syntax

[ 'Items' => [ [ 'CommentMetadata' => [ 'CommentId' => '', 'CommentStatus' => 'DRAFT|PUBLISHED|DELETED', 'Contributor' => [ 'CreatedTimestamp' => , 'EmailAddress' => '', 'GivenName' => '', 'Id' => '', 'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default', 'ModifiedTimestamp' => , 'OrganizationId' => '', 'RecycleBinFolderId' => '', 'RootFolderId' => '', 'Status' => 'ACTIVE|INACTIVE|PENDING', 'Storage' => [ 'StorageRule' => [ 'StorageAllocatedInBytes' => , 'StorageType' => 'UNLIMITED|QUOTA', ], 'StorageUtilizedInBytes' => , ], 'Surname' => '', 'TimeZoneId' => '', 'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER', 'Username' => '', ], 'ContributorId' => '', 'CreatedTimestamp' => , 'RecipientId' => '', ], 'DocumentMetadata' => [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionMetadata' => [ 'ContentCreatedTimestamp' => , 'ContentModifiedTimestamp' => , 'ContentType' => '', 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'ModifiedTimestamp' => , 'Name' => '', 'Signature' => '', 'Size' => , 'Source' => ['', ...], 'Status' => 'INITIALIZED|ACTIVE', 'Thumbnail' => ['', ...], ], 'ModifiedTimestamp' => , 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', ], 'DocumentVersionMetadata' => [ 'ContentCreatedTimestamp' => , 'ContentModifiedTimestamp' => , 'ContentType' => '', 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'ModifiedTimestamp' => , 'Name' => '', 'Signature' => '', 'Size' => , 'Source' => ['', ...], 'Status' => 'INITIALIZED|ACTIVE', 'Thumbnail' => ['', ...], ], 'FolderMetadata' => [ 'CreatedTimestamp' => , 'CreatorId' => '', 'Id' => '', 'Labels' => ['', ...], 'LatestVersionSize' => , 'ModifiedTimestamp' => , 'Name' => '', 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', 'Signature' => '', 'Size' => , ], 'ResourceType' => 'DOCUMENT|FOLDER|COMMENT|DOCUMENT_VERSION', 'WebUrl' => '', ], // ... ], 'Marker' => '', ]

Result Details

Members

Items

Type: Array of ResponseItem structures

List of Documents, Folders, Comments, and Document Versions matching the query.

Marker

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Errors

The pagination marker or limit fields are not valid.

The caller does not have access to perform the action on the resource.

The operation is not permitted.

One or more of the dependencies is unavailable.

UpdateDocument

result=result = result=client->updateDocument([/* ... /]); promise=promise = promise=client->updateDocumentAsync([/ ... */]);

Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

Parameter Syntax

result=result = result=client->updateDocument([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED 'Name' => '', 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

Name

The name of the document.

ParentFolderId

The ID of the parent folder.

ResourceState

The resource state of the document. Only ACTIVE and RECYCLED are supported.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The resource already exists.

The maximum of 100,000 files and folders under the parent folder has been exceeded.

The specified document version is not in the INITIALIZED state.

Another operation is in progress on the resource that conflicts with the current operation.

The resource hierarchy is changing.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

UpdateDocumentVersion

result=result = result=client->updateDocumentVersion([/* ... /]); promise=promise = promise=client->updateDocumentVersionAsync([/ ... */]);

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.

Parameter Syntax

result=result = result=client->updateDocumentVersion([ 'AuthenticationToken' => '', 'DocumentId' => '', // REQUIRED 'VersionId' => '', // REQUIRED 'VersionStatus' => 'ACTIVE', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

DocumentId

Required: Yes

Type: string

The ID of the document.

VersionId

Required: Yes

Type: string

The version ID of the document.

VersionStatus

The status of the version.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The specified document version is not in the INITIALIZED state.

InvalidOperationException:

The resource hierarchy is changing.

The operation is invalid.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

UpdateFolder

result=result = result=client->updateFolder([/* ... /]); promise=promise = promise=client->updateFolderAsync([/ ... */]);

Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.

Parameter Syntax

result=result = result=client->updateFolder([ 'AuthenticationToken' => '', 'FolderId' => '', // REQUIRED 'Name' => '', 'ParentFolderId' => '', 'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED', ]);

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

FolderId

Required: Yes

Type: string

The ID of the folder.

Name

The name of the folder.

ParentFolderId

The ID of the parent folder.

ResourceState

The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The resource does not exist.

The resource already exists.

The specified document version is not in the INITIALIZED state.

Another operation is in progress on the resource that conflicts with the current operation.

The resource hierarchy is changing.

The maximum of 100,000 files and folders under the parent folder has been exceeded.

The operation is not permitted.

The caller does not have access to perform the action on the resource.

The 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.

One or more of the dependencies is unavailable.

UpdateUser

result=result = result=client->updateUser([/* ... /]); promise=promise = promise=client->updateUserAsync([/ ... */]);

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Parameter Syntax

Parameter Details

Members

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

GivenName

The given name of the user.

GrantPoweruserPrivileges

Boolean value to determine whether the user is granted Power user privileges.

Locale

The locale of the user.

StorageRule

Type: StorageRuleType structure

The amount of storage for the user.

Surname

The surname of the user.

TimeZoneId

The time zone ID of the user.

Type

The type of the user.

UserId

Required: Yes

Type: string

The ID of the user.

Result Syntax

Result Details

Members

User

The user information.

Errors

The resource does not exist.

The operation is not permitted.

IllegalUserStateException:

The caller does not have access to perform the action on the resource.

The user is undergoing transfer of ownership.

The specified document version is not in the INITIALIZED state.

The 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.

DeactivatingLastSystemUserException:

One or more of the dependencies is unavailable.

The last user in the organization is being deactivated.