AbortDocumentVersionUpload

$result = $client->abortDocumentVersionUpload([/* ... */]);
$promise = $client->abortDocumentVersionUploadAsync([/* ... */]);

Aborts the upload of the specified 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.

Parameter Syntax

$result = $client->abortDocumentVersionUpload([
    'AuthenticationToken' => '<string>',
    'DocumentId' => '<string>', // REQUIRED
    'VersionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

ConcurrentModificationException:

The resource hierarchy is changing.

ActivateUser

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'User' => [
        'CreatedTimestamp' => <DateTime>,
        'EmailAddress' => '<string>',
        'GivenName' => '<string>',
        'Id' => '<string>',
        'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default',
        'ModifiedTimestamp' => <DateTime>,
        'OrganizationId' => '<string>',
        'RecycleBinFolderId' => '<string>',
        'RootFolderId' => '<string>',
        'Status' => 'ACTIVE|INACTIVE|PENDING',
        'Storage' => [
            'StorageRule' => [
                'StorageAllocatedInBytes' => <integer>,
                'StorageType' => 'UNLIMITED|QUOTA',
            ],
            'StorageUtilizedInBytes' => <integer>,
        ],
        'Surname' => '<string>',
        'TimeZoneId' => '<string>',
        'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER',
        'Username' => '<string>',
    ],
]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

AddResourcePermissions

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

Parameter Details

Result Syntax

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

Result Details

Errors

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

CreateComment

$result = $client->createComment([/* ... */]);
$promise = $client->createCommentAsync([/* ... */]);

Adds a new comment to the specified document version.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Comment' => [
        'CommentId' => '<string>',
        'Contributor' => [
            'CreatedTimestamp' => <DateTime>,
            'EmailAddress' => '<string>',
            'GivenName' => '<string>',
            'Id' => '<string>',
            'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default',
            'ModifiedTimestamp' => <DateTime>,
            'OrganizationId' => '<string>',
            'RecycleBinFolderId' => '<string>',
            'RootFolderId' => '<string>',
            'Status' => 'ACTIVE|INACTIVE|PENDING',
            'Storage' => [
                'StorageRule' => [
                    'StorageAllocatedInBytes' => <integer>,
                    'StorageType' => 'UNLIMITED|QUOTA',
                ],
                'StorageUtilizedInBytes' => <integer>,
            ],
            'Surname' => '<string>',
            'TimeZoneId' => '<string>',
            'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER',
            'Username' => '<string>',
        ],
        'CreatedTimestamp' => <DateTime>,
        'ParentId' => '<string>',
        'RecipientId' => '<string>',
        'Status' => 'DRAFT|PUBLISHED|DELETED',
        'Text' => '<string>',
        'ThreadId' => '<string>',
        'Visibility' => 'PUBLIC|PRIVATE',
    ],
]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DocumentLockedForCommentsException:

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 = $client->createCustomMetadata([/* ... */]);
$promise = $client->createCustomMetadataAsync([/* ... */]);

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

CustomMetadataLimitExceededException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

CreateFolder

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

Creates a folder with the specified name and parent folder.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

EntityAlreadyExistsException:

The resource already exists.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConflictingOperationException:

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

ConcurrentModificationException:

The resource hierarchy is changing.

LimitExceededException:

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

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

CreateLabels

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

TooManyLabelsException:

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

CreateNotificationSubscription

$result = $client->createNotificationSubscription([/* ... */]);
$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 = $client->createNotificationSubscription([
    'Endpoint' => '<string>', // REQUIRED
    'OrganizationId' => '<string>', // REQUIRED
    'Protocol' => 'HTTPS|SQS', // REQUIRED
    'SubscriptionType' => 'ALL', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

UnauthorizedResourceAccessException:

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

TooManySubscriptionsException:

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

ServiceUnavailableException:

One or more of the dependencies is unavailable.

InvalidArgumentException:

The pagination marker or limit fields are not valid.

CreateUser

$result = $client->createUser([/* ... */]);
$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 = $client->createUser([
    'AuthenticationToken' => '<string>',
    'EmailAddress' => '<string>',
    'GivenName' => '<string>', // REQUIRED
    'OrganizationId' => '<string>',
    'Password' => '<string>', // REQUIRED
    'StorageRule' => [
        'StorageAllocatedInBytes' => <integer>,
        'StorageType' => 'UNLIMITED|QUOTA',
    ],
    'Surname' => '<string>', // REQUIRED
    'TimeZoneId' => '<string>',
    'Username' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'CreatedTimestamp' => <DateTime>,
        'EmailAddress' => '<string>',
        'GivenName' => '<string>',
        'Id' => '<string>',
        'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default',
        'ModifiedTimestamp' => <DateTime>,
        'OrganizationId' => '<string>',
        'RecycleBinFolderId' => '<string>',
        'RootFolderId' => '<string>',
        'Status' => 'ACTIVE|INACTIVE|PENDING',
        'Storage' => [
            'StorageRule' => [
                'StorageAllocatedInBytes' => <integer>,
                'StorageType' => 'UNLIMITED|QUOTA',
            ],
            'StorageUtilizedInBytes' => <integer>,
        ],
        'Surname' => '<string>',
        'TimeZoneId' => '<string>',
        'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER',
        'Username' => '<string>',
    ],
]

Result Details

Errors

EntityAlreadyExistsException:

The resource already exists.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DeactivateUser

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DeleteComment

$result = $client->deleteComment([/* ... */]);
$promise = $client->deleteCommentAsync([/* ... */]);

Deletes the specified comment from the document version.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DocumentLockedForCommentsException:

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 = $client->deleteCustomMetadata([/* ... */]);
$promise = $client->deleteCustomMetadataAsync([/* ... */]);

Deletes custom metadata from the specified resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DeleteDocument

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

Permanently deletes the specified document and its associated metadata.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

LimitExceededException:

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

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConflictingOperationException:

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

ConcurrentModificationException:

The resource hierarchy is changing.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DeleteDocumentVersion

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

Deletes a specific version of a document.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConflictingOperationException:

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

ConcurrentModificationException:

The resource hierarchy is changing.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

InvalidOperationException:

The operation is invalid.

UnauthorizedOperationException:

The operation is not permitted.

DeleteFolder

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

Permanently deletes the specified folder and its contents.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

LimitExceededException:

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

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConflictingOperationException:

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

ConcurrentModificationException:

The resource hierarchy is changing.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DeleteFolderContents

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

Deletes the contents of the specified folder.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConflictingOperationException:

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

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DeleteLabels

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

Deletes the specified list of labels from a resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

DeleteNotificationSubscription

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

Deletes the specified subscription from the specified organization.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedResourceAccessException:

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

EntityNotExistsException:

The resource does not exist.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

DeleteUser

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DescribeActivities

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

Describes the user activities in a specified time period.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Errors

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

InvalidArgumentException:

The pagination marker or limit fields are not valid.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DescribeComments

$result = $client->describeComments([/* ... */]);
$promise = $client->describeCommentsAsync([/* ... */]);

List all the comments for the specified document version.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Comments' => [
        [
            'CommentId' => '<string>',
            'Contributor' => [
                'CreatedTimestamp' => <DateTime>,
                'EmailAddress' => '<string>',
                'GivenName' => '<string>',
                'Id' => '<string>',
                'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default',
                'ModifiedTimestamp' => <DateTime>,
                'OrganizationId' => '<string>',
                'RecycleBinFolderId' => '<string>',
                'RootFolderId' => '<string>',
                'Status' => 'ACTIVE|INACTIVE|PENDING',
                'Storage' => [
                    'StorageRule' => [
                        'StorageAllocatedInBytes' => <integer>,
                        'StorageType' => 'UNLIMITED|QUOTA',
                    ],
                    'StorageUtilizedInBytes' => <integer>,
                ],
                'Surname' => '<string>',
                'TimeZoneId' => '<string>',
                'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER',
                'Username' => '<string>',
            ],
            'CreatedTimestamp' => <DateTime>,
            'ParentId' => '<string>',
            'RecipientId' => '<string>',
            'Status' => 'DRAFT|PUBLISHED|DELETED',
            'Text' => '<string>',
            'ThreadId' => '<string>',
            'Visibility' => 'PUBLIC|PRIVATE',
        ],
        // ...
    ],
    'Marker' => '<string>',
]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DescribeDocumentVersions

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

Retrieves the document versions for the specified document.

By default, only active versions are returned.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

InvalidArgumentException:

The pagination marker or limit fields are not valid.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

InvalidPasswordException:

The password is invalid.

DescribeFolderContents

$result = $client->describeFolderContents([/* ... */]);
$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 = $client->describeFolderContents([
    'AuthenticationToken' => '<string>',
    'FolderId' => '<string>', // REQUIRED
    'Include' => '<string>',
    'Limit' => <integer>,
    'Marker' => '<string>',
    'Order' => 'ASCENDING|DESCENDING',
    'Sort' => 'DATE|NAME',
    'Type' => 'ALL|DOCUMENT|FOLDER',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedResourceAccessException:

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

InvalidArgumentException:

The pagination marker or limit fields are not valid.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

DescribeGroups

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DescribeNotificationSubscriptions

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

Lists the specified notification subscriptions.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

UnauthorizedResourceAccessException:

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

EntityNotExistsException:

The resource does not exist.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DescribeResourcePermissions

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

Describes the permissions of a specified resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'Principals' => [
        [
            'Id' => '<string>',
            'Roles' => [
                [
                    'Role' => 'VIEWER|CONTRIBUTOR|OWNER|COOWNER',
                    'Type' => 'DIRECT|INHERITED',
                ],
                // ...
            ],
            'Type' => 'USER|GROUP|INVITE|ANONYMOUS|ORGANIZATION',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidArgumentException:

The pagination marker or limit fields are not valid.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DescribeRootFolders

$result = $client->describeRootFolders([/* ... */]);
$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 = $client->describeRootFolders([
    'AuthenticationToken' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

InvalidArgumentException:

The pagination marker or limit fields are not valid.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DescribeUsers

$result = $client->describeUsers([/* ... */]);
$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 = $client->describeUsers([
    'AuthenticationToken' => '<string>',
    'Fields' => '<string>',
    'Include' => 'ALL|ACTIVE_PENDING',
    'Limit' => <integer>,
    'Marker' => '<string>',
    'Order' => 'ASCENDING|DESCENDING',
    'OrganizationId' => '<string>',
    'Query' => '<string>',
    'Sort' => 'USER_NAME|FULL_NAME|STORAGE_LIMIT|USER_STATUS|STORAGE_USED',
    'UserIds' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Marker' => '<string>',
    'TotalNumberOfUsers' => <integer>,
    'Users' => [
        [
            'CreatedTimestamp' => <DateTime>,
            'EmailAddress' => '<string>',
            'GivenName' => '<string>',
            'Id' => '<string>',
            'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default',
            'ModifiedTimestamp' => <DateTime>,
            'OrganizationId' => '<string>',
            'RecycleBinFolderId' => '<string>',
            'RootFolderId' => '<string>',
            'Status' => 'ACTIVE|INACTIVE|PENDING',
            'Storage' => [
                'StorageRule' => [
                    'StorageAllocatedInBytes' => <integer>,
                    'StorageType' => 'UNLIMITED|QUOTA',
                ],
                'StorageUtilizedInBytes' => <integer>,
            ],
            'Surname' => '<string>',
            'TimeZoneId' => '<string>',
            'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER',
            'Username' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

InvalidArgumentException:

The pagination marker or limit fields are not valid.

RequestedEntityTooLargeException:

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

GetCurrentUser

$result = $client->getCurrentUser([/* ... */]);
$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.

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 = $client->getCurrentUser([
    'AuthenticationToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'CreatedTimestamp' => <DateTime>,
        'EmailAddress' => '<string>',
        'GivenName' => '<string>',
        'Id' => '<string>',
        'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default',
        'ModifiedTimestamp' => <DateTime>,
        'OrganizationId' => '<string>',
        'RecycleBinFolderId' => '<string>',
        'RootFolderId' => '<string>',
        'Status' => 'ACTIVE|INACTIVE|PENDING',
        'Storage' => [
            'StorageRule' => [
                'StorageAllocatedInBytes' => <integer>,
                'StorageType' => 'UNLIMITED|QUOTA',
            ],
            'StorageUtilizedInBytes' => <integer>,
        ],
        'Surname' => '<string>',
        'TimeZoneId' => '<string>',
        'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER',
        'Username' => '<string>',
    ],
]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

GetDocument

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

Retrieves details of a document.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

InvalidArgumentException:

The pagination marker or limit fields are not valid.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

InvalidPasswordException:

The password is invalid.

GetDocumentPath

$result = $client->getDocumentPath([/* ... */]);
$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 = $client->getDocumentPath([
    'AuthenticationToken' => '<string>',
    'DocumentId' => '<string>', // REQUIRED
    'Fields' => '<string>',
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

GetDocumentVersion

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

Retrieves version metadata for the specified document.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

InvalidPasswordException:

The password is invalid.

GetFolder

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

Retrieves the metadata of the specified folder.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

InvalidArgumentException:

The pagination marker or limit fields are not valid.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

GetFolderPath

$result = $client->getFolderPath([/* ... */]);
$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 = $client->getFolderPath([
    'AuthenticationToken' => '<string>',
    'Fields' => '<string>',
    'FolderId' => '<string>', // REQUIRED
    'Limit' => <integer>,
    'Marker' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

GetResources

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

UnauthorizedResourceAccessException:

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

UnauthorizedOperationException:

The operation is not permitted.

InvalidArgumentException:

The pagination marker or limit fields are not valid.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

InitiateDocumentVersionUpload

$result = $client->initiateDocumentVersionUpload([/* ... */]);
$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 = $client->initiateDocumentVersionUpload([
    'AuthenticationToken' => '<string>',
    'ContentCreatedTimestamp' => <integer || string || DateTime>,
    'ContentModifiedTimestamp' => <integer || string || DateTime>,
    'ContentType' => '<string>',
    'DocumentSizeInBytes' => <integer>,
    'Id' => '<string>',
    'Name' => '<string>',
    'ParentFolderId' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

EntityAlreadyExistsException:

The resource already exists.

StorageLimitExceededException:

The storage limit has been exceeded.

StorageLimitWillExceedException:

The storage limit will be exceeded.

LimitExceededException:

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

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

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.

ResourceAlreadyCheckedOutException:

The resource is already checked out.

InvalidPasswordException:

The password is invalid.

InvalidArgumentException:

The pagination marker or limit fields are not valid.

RemoveAllResourcePermissions

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

Removes all the permissions from the specified resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

RemoveResourcePermission

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

RestoreDocumentVersions

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

Recovers a deleted version of an Amazon WorkDocs document.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConflictingOperationException:

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

ConcurrentModificationException:

The resource hierarchy is changing.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

InvalidOperationException:

The operation is invalid.

UnauthorizedOperationException:

The operation is not permitted.

SearchResources

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidArgumentException:

The pagination marker or limit fields are not valid.

UnauthorizedResourceAccessException:

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

UnauthorizedOperationException:

The operation is not permitted.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

UpdateDocument

$result = $client->updateDocument([/* ... */]);
$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 = $client->updateDocument([
    'AuthenticationToken' => '<string>',
    'DocumentId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'ParentFolderId' => '<string>',
    'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

EntityAlreadyExistsException:

The resource already exists.

LimitExceededException:

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

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConflictingOperationException:

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

ConcurrentModificationException:

The resource hierarchy is changing.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

UpdateDocumentVersion

$result = $client->updateDocumentVersion([/* ... */]);
$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 = $client->updateDocumentVersion([
    'AuthenticationToken' => '<string>',
    'DocumentId' => '<string>', // REQUIRED
    'VersionId' => '<string>', // REQUIRED
    'VersionStatus' => 'ACTIVE',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConcurrentModificationException:

The resource hierarchy is changing.

InvalidOperationException:

The operation is invalid.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

UpdateFolder

$result = $client->updateFolder([/* ... */]);
$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 = $client->updateFolder([
    'AuthenticationToken' => '<string>',
    'FolderId' => '<string>', // REQUIRED
    'Name' => '<string>',
    'ParentFolderId' => '<string>',
    'ResourceState' => 'ACTIVE|RESTORING|RECYCLING|RECYCLED',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

EntityAlreadyExistsException:

The resource already exists.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

ConflictingOperationException:

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

ConcurrentModificationException:

The resource hierarchy is changing.

LimitExceededException:

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

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

UpdateUser

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

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

Parameter Syntax

$result = $client->updateUser([
    'AuthenticationToken' => '<string>',
    'GivenName' => '<string>',
    'GrantPoweruserPrivileges' => 'TRUE|FALSE',
    'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default',
    'StorageRule' => [
        'StorageAllocatedInBytes' => <integer>,
        'StorageType' => 'UNLIMITED|QUOTA',
    ],
    'Surname' => '<string>',
    'TimeZoneId' => '<string>',
    'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER',
    'UserId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'User' => [
        'CreatedTimestamp' => <DateTime>,
        'EmailAddress' => '<string>',
        'GivenName' => '<string>',
        'Id' => '<string>',
        'Locale' => 'en|fr|ko|de|es|ja|ru|zh_CN|zh_TW|pt_BR|default',
        'ModifiedTimestamp' => <DateTime>,
        'OrganizationId' => '<string>',
        'RecycleBinFolderId' => '<string>',
        'RootFolderId' => '<string>',
        'Status' => 'ACTIVE|INACTIVE|PENDING',
        'Storage' => [
            'StorageRule' => [
                'StorageAllocatedInBytes' => <integer>,
                'StorageType' => 'UNLIMITED|QUOTA',
            ],
            'StorageUtilizedInBytes' => <integer>,
        ],
        'Surname' => '<string>',
        'TimeZoneId' => '<string>',
        'Type' => 'USER|ADMIN|POWERUSER|MINIMALUSER|WORKSPACESUSER',
        'Username' => '<string>',
    ],
]

Result Details

Errors

EntityNotExistsException:

The resource does not exist.

UnauthorizedOperationException:

The operation is not permitted.

UnauthorizedResourceAccessException:

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

IllegalUserStateException:

The user is undergoing transfer of ownership.

ProhibitedStateException:

The specified document version is not in the INITIALIZED state.

FailedDependencyException:

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.

ServiceUnavailableException:

One or more of the dependencies is unavailable.

DeactivatingLastSystemUserException:

The last user in the organization is being deactivated.

InvalidArgumentException:

The pagination marker or limit fields are not valid.