/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the workdocs-2016-05-01.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.WorkDocs.Model; namespace Amazon.WorkDocs { /// /// Interface for accessing WorkDocs /// /// The Amazon WorkDocs API is designed for the following use cases: /// /// /// /// All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They /// not only require the use of the Amazon Web Services SDK, but also allow for the exclusive /// use of IAM users and roles to help facilitate access, trust, and permission policies. /// By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the /// IAM user gains full administrative visibility into the entire Amazon WorkDocs site /// (or as set in the IAM policy). This includes, but is not limited to, the ability to /// modify file permissions and upload any file to any user. This allows developers to /// perform the three use cases above, as well as give users the ability to grant access /// on a selective basis using the IAM model. /// /// /// /// The pricing for Amazon WorkDocs APIs varies depending on the API call type for these /// actions: /// /// /// /// For information about Amazon WorkDocs API pricing, see Amazon /// WorkDocs Pricing. /// /// /// public partial interface IAmazonWorkDocs : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API /// /// Paginators for the service /// IWorkDocsPaginatorFactory Paginators { get; } #endif #region AbortDocumentVersionUpload /// /// 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. /// /// Container for the necessary parameters to execute the AbortDocumentVersionUpload service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AbortDocumentVersionUpload service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// The resource does not exist. /// /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for AbortDocumentVersionUpload Operation Task AbortDocumentVersionUploadAsync(AbortDocumentVersionUploadRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ActivateUser /// /// Activates the specified user. Only active users can access Amazon WorkDocs. /// /// Container for the necessary parameters to execute the ActivateUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ActivateUser service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for ActivateUser Operation Task ActivateUserAsync(ActivateUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region AddResourcePermissions /// /// Creates a set of permissions for the specified folder or document. The resource permissions /// are overwritten if the principals already have different permissions. /// /// Container for the necessary parameters to execute the AddResourcePermissions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AddResourcePermissions service method, as returned by WorkDocs. /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for AddResourcePermissions Operation Task AddResourcePermissionsAsync(AddResourcePermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateComment /// /// Adds a new comment to the specified document version. /// /// Container for the necessary parameters to execute the CreateComment service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateComment service method, as returned by WorkDocs. /// /// This exception is thrown when the document is locked for comments and user tries to /// create or delete a comment on that document. /// /// /// The resource does not exist. /// /// /// 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 requested operation is not allowed on the specified comment object. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for CreateComment Operation Task CreateCommentAsync(CreateCommentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateCustomMetadata /// /// Adds one or more custom properties to the specified resource (a folder, document, /// or version). /// /// Container for the necessary parameters to execute the CreateCustomMetadata service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateCustomMetadata service method, as returned by WorkDocs. /// /// The limit has been reached on the number of custom properties for the specified resource. /// /// /// The resource does not exist. /// /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for CreateCustomMetadata Operation Task CreateCustomMetadataAsync(CreateCustomMetadataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateFolder /// /// Creates a folder with the specified name and parent folder. /// /// Container for the necessary parameters to execute the CreateFolder service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateFolder service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// Another operation is in progress on the resource that conflicts with the current operation. /// /// /// The resource already exists. /// /// /// The resource does not exist. /// /// /// 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 maximum of 100,000 files and folders under the parent folder has been exceeded. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for CreateFolder Operation Task CreateFolderAsync(CreateFolderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateLabels /// /// Adds the specified list of labels to the given resource (a document or folder) /// /// Container for the necessary parameters to execute the CreateLabels service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateLabels service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 limit has been reached on the number of labels for the specified resource. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for CreateLabels Operation Task CreateLabelsAsync(CreateLabelsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateNotificationSubscription /// /// 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. /// /// /// Container for the necessary parameters to execute the CreateNotificationSubscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateNotificationSubscription service method, as returned by WorkDocs. /// /// The pagination marker or limit fields are not valid. /// /// /// One or more of the dependencies is unavailable. /// /// /// You've reached the limit on the number of subscriptions for the WorkDocs instance. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for CreateNotificationSubscription Operation Task CreateNotificationSubscriptionAsync(CreateNotificationSubscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region CreateUser /// /// 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. /// /// Container for the necessary parameters to execute the CreateUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the CreateUser service method, as returned by WorkDocs. /// /// The resource already exists. /// /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for CreateUser Operation Task CreateUserAsync(CreateUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeactivateUser /// /// Deactivates the specified user, which revokes the user's access to Amazon WorkDocs. /// /// Container for the necessary parameters to execute the DeactivateUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeactivateUser service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeactivateUser Operation Task DeactivateUserAsync(DeactivateUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteComment /// /// Deletes the specified comment from the document version. /// /// Container for the necessary parameters to execute the DeleteComment service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteComment service method, as returned by WorkDocs. /// /// This exception is thrown when the document is locked for comments and user tries to /// create or delete a comment on that document. /// /// /// The resource does not exist. /// /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeleteComment Operation Task DeleteCommentAsync(DeleteCommentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteCustomMetadata /// /// Deletes custom metadata from the specified resource. /// /// Container for the necessary parameters to execute the DeleteCustomMetadata service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCustomMetadata service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeleteCustomMetadata Operation Task DeleteCustomMetadataAsync(DeleteCustomMetadataRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDocument /// /// Permanently deletes the specified document and its associated metadata. /// /// Container for the necessary parameters to execute the DeleteDocument service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDocument service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// Another operation is in progress on the resource that conflicts with the current operation. /// /// /// The resource does not exist. /// /// /// 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 maximum of 100,000 files and folders under the parent folder has been exceeded. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeleteDocument Operation Task DeleteDocumentAsync(DeleteDocumentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteDocumentVersion /// /// Deletes a specific version of a document. /// /// Container for the necessary parameters to execute the DeleteDocumentVersion service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteDocumentVersion service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// Another operation is in progress on the resource that conflicts with the current operation. /// /// /// The resource does not exist. /// /// /// 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 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. /// /// REST API Reference for DeleteDocumentVersion Operation Task DeleteDocumentVersionAsync(DeleteDocumentVersionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteFolder /// /// Permanently deletes the specified folder and its contents. /// /// Container for the necessary parameters to execute the DeleteFolder service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteFolder service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// Another operation is in progress on the resource that conflicts with the current operation. /// /// /// The resource does not exist. /// /// /// 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 maximum of 100,000 files and folders under the parent folder has been exceeded. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeleteFolder Operation Task DeleteFolderAsync(DeleteFolderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteFolderContents /// /// Deletes the contents of the specified folder. /// /// Container for the necessary parameters to execute the DeleteFolderContents service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteFolderContents service method, as returned by WorkDocs. /// /// Another operation is in progress on the resource that conflicts with the current operation. /// /// /// The resource does not exist. /// /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeleteFolderContents Operation Task DeleteFolderContentsAsync(DeleteFolderContentsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteLabels /// /// Deletes the specified list of labels from a resource. /// /// Container for the necessary parameters to execute the DeleteLabels service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteLabels service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeleteLabels Operation Task DeleteLabelsAsync(DeleteLabelsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteNotificationSubscription /// /// Deletes the specified subscription from the specified organization. /// /// Container for the necessary parameters to execute the DeleteNotificationSubscription service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteNotificationSubscription service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeleteNotificationSubscription Operation Task DeleteNotificationSubscriptionAsync(DeleteNotificationSubscriptionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteUser /// /// 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. /// /// /// /// Container for the necessary parameters to execute the DeleteUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteUser service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DeleteUser Operation Task DeleteUserAsync(DeleteUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeActivities /// /// Describes the user activities in a specified time period. /// /// Container for the necessary parameters to execute the DescribeActivities service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeActivities service method, as returned by WorkDocs. /// /// 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 pagination marker or limit fields are not valid. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeActivities Operation Task DescribeActivitiesAsync(DescribeActivitiesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeComments /// /// List all the comments for the specified document version. /// /// Container for the necessary parameters to execute the DescribeComments service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeComments service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeComments Operation Task DescribeCommentsAsync(DescribeCommentsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeDocumentVersions /// /// Retrieves the document versions for the specified document. /// /// /// /// By default, only active versions are returned. /// /// /// Container for the necessary parameters to execute the DescribeDocumentVersions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeDocumentVersions service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 pagination marker or limit fields are not valid. /// /// /// The password is invalid. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeDocumentVersions Operation Task DescribeDocumentVersionsAsync(DescribeDocumentVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeFolderContents /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeFolderContents service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeFolderContents service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 pagination marker or limit fields are not valid. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeFolderContents Operation Task DescribeFolderContentsAsync(DescribeFolderContentsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeGroups /// /// Describes the groups specified by the query. Groups are defined by the underlying /// Active Directory. /// /// Container for the necessary parameters to execute the DescribeGroups service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeGroups service method, as returned by WorkDocs. /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeGroups Operation Task DescribeGroupsAsync(DescribeGroupsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeNotificationSubscriptions /// /// Lists the specified notification subscriptions. /// /// Container for the necessary parameters to execute the DescribeNotificationSubscriptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeNotificationSubscriptions service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// One or more of the dependencies is unavailable. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeNotificationSubscriptions Operation Task DescribeNotificationSubscriptionsAsync(DescribeNotificationSubscriptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeResourcePermissions /// /// Describes the permissions of a specified resource. /// /// Container for the necessary parameters to execute the DescribeResourcePermissions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeResourcePermissions service method, as returned by WorkDocs. /// /// 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 pagination marker or limit fields are not valid. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeResourcePermissions Operation Task DescribeResourcePermissionsAsync(DescribeResourcePermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeRootFolders /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeRootFolders service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeRootFolders service method, as returned by WorkDocs. /// /// 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 pagination marker or limit fields are not valid. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeRootFolders Operation Task DescribeRootFoldersAsync(DescribeRootFoldersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeUsers /// /// 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. /// /// /// Container for the necessary parameters to execute the DescribeUsers service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeUsers service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 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. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for DescribeUsers Operation Task DescribeUsersAsync(DescribeUsersRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetCurrentUser /// /// 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. /// /// /// Container for the necessary parameters to execute the GetCurrentUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetCurrentUser service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for GetCurrentUser Operation Task GetCurrentUserAsync(GetCurrentUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDocument /// /// Retrieves details of a document. /// /// Container for the necessary parameters to execute the GetDocument service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDocument service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 pagination marker or limit fields are not valid. /// /// /// The password is invalid. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for GetDocument Operation Task GetDocumentAsync(GetDocumentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDocumentPath /// /// 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. /// /// /// Container for the necessary parameters to execute the GetDocumentPath service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDocumentPath service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for GetDocumentPath Operation Task GetDocumentPathAsync(GetDocumentPathRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetDocumentVersion /// /// Retrieves version metadata for the specified document. /// /// Container for the necessary parameters to execute the GetDocumentVersion service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetDocumentVersion service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 password is invalid. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for GetDocumentVersion Operation Task GetDocumentVersionAsync(GetDocumentVersionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetFolder /// /// Retrieves the metadata of the specified folder. /// /// Container for the necessary parameters to execute the GetFolder service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetFolder service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 pagination marker or limit fields are not valid. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for GetFolder Operation Task GetFolderAsync(GetFolderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetFolderPath /// /// 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. /// /// /// Container for the necessary parameters to execute the GetFolderPath service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetFolderPath service method, as returned by WorkDocs. /// /// The resource does not exist. /// /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for GetFolderPath Operation Task GetFolderPathAsync(GetFolderPathRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetResources /// /// Retrieves a collection of resources, including folders and documents. The only CollectionType /// supported is SHARED_WITH_ME. /// /// Container for the necessary parameters to execute the GetResources service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetResources service method, as returned by WorkDocs. /// /// 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 pagination marker or limit fields are not valid. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for GetResources Operation Task GetResourcesAsync(GetResourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region InitiateDocumentVersionUpload /// /// 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. /// /// /// Container for the necessary parameters to execute the InitiateDocumentVersionUpload service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the InitiateDocumentVersionUpload service method, as returned by WorkDocs. /// /// 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. /// /// /// The resource already exists. /// /// /// The resource does not exist. /// /// /// 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 pagination marker or limit fields are not valid. /// /// /// The password is invalid. /// /// /// 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 resource is already checked out. /// /// /// One or more of the dependencies is unavailable. /// /// /// The storage limit has been exceeded. /// /// /// The storage limit will be exceeded. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for InitiateDocumentVersionUpload Operation Task InitiateDocumentVersionUploadAsync(InitiateDocumentVersionUploadRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveAllResourcePermissions /// /// Removes all the permissions from the specified resource. /// /// Container for the necessary parameters to execute the RemoveAllResourcePermissions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveAllResourcePermissions service method, as returned by WorkDocs. /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for RemoveAllResourcePermissions Operation Task RemoveAllResourcePermissionsAsync(RemoveAllResourcePermissionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveResourcePermission /// /// Removes the permission for the specified principal from the specified resource. /// /// Container for the necessary parameters to execute the RemoveResourcePermission service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveResourcePermission service method, as returned by WorkDocs. /// /// 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 operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for RemoveResourcePermission Operation Task RemoveResourcePermissionAsync(RemoveResourcePermissionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RestoreDocumentVersions /// /// Recovers a deleted version of an Amazon WorkDocs document. /// /// Container for the necessary parameters to execute the RestoreDocumentVersions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RestoreDocumentVersions service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// Another operation is in progress on the resource that conflicts with the current operation. /// /// /// The resource does not exist. /// /// /// 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 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. /// /// REST API Reference for RestoreDocumentVersions Operation Task RestoreDocumentVersionsAsync(RestoreDocumentVersionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region SearchResources /// /// Searches metadata and the content of folders, documents, document versions, and comments. /// /// Container for the necessary parameters to execute the SearchResources service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the SearchResources service method, as returned by WorkDocs. /// /// The pagination marker or limit fields are not valid. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for SearchResources Operation Task SearchResourcesAsync(SearchResourcesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateDocument /// /// Updates the specified attributes of a document. The user must have access to both /// the document and its parent folder, if applicable. /// /// Container for the necessary parameters to execute the UpdateDocument service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateDocument service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// Another operation is in progress on the resource that conflicts with the current operation. /// /// /// The resource already exists. /// /// /// The resource does not exist. /// /// /// 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 maximum of 100,000 files and folders under the parent folder has been exceeded. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for UpdateDocument Operation Task UpdateDocumentAsync(UpdateDocumentRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateDocumentVersion /// /// 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. /// /// /// Container for the necessary parameters to execute the UpdateDocumentVersion service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateDocumentVersion service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// The resource does not exist. /// /// /// 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 specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for UpdateDocumentVersion Operation Task UpdateDocumentVersionAsync(UpdateDocumentVersionRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateFolder /// /// Updates the specified attributes of the specified folder. The user must have access /// to both the folder and its parent folder, if applicable. /// /// Container for the necessary parameters to execute the UpdateFolder service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateFolder service method, as returned by WorkDocs. /// /// The resource hierarchy is changing. /// /// /// Another operation is in progress on the resource that conflicts with the current operation. /// /// /// The resource already exists. /// /// /// The resource does not exist. /// /// /// 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 maximum of 100,000 files and folders under the parent folder has been exceeded. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for UpdateFolder Operation Task UpdateFolderAsync(UpdateFolderRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateUser /// /// Updates the specified attributes of the specified user, and grants or revokes administrative /// privileges to the Amazon WorkDocs site. /// /// Container for the necessary parameters to execute the UpdateUser service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateUser service method, as returned by WorkDocs. /// /// The last user in the organization is being deactivated. /// /// /// The resource does not exist. /// /// /// 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 user is undergoing transfer of ownership. /// /// /// The pagination marker or limit fields are not valid. /// /// /// The specified document version is not in the INITIALIZED state. /// /// /// One or more of the dependencies is unavailable. /// /// /// The operation is not permitted. /// /// /// The caller does not have access to perform the action on the resource. /// /// REST API Reference for UpdateUser Operation Task UpdateUserAsync(UpdateUserRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }