Class: Aws::WorkDocs::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::WorkDocs::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb
Overview
An API client for WorkDocs. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::WorkDocs::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#abort_document_version_upload(params = {}) ⇒ Struct
Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload.
-
#activate_user(params = {}) ⇒ Types::ActivateUserResponse
Activates the specified user.
-
#add_resource_permissions(params = {}) ⇒ Types::AddResourcePermissionsResponse
Creates a set of permissions for the specified folder or document.
-
#create_comment(params = {}) ⇒ Types::CreateCommentResponse
Adds a new comment to the specified document version.
-
#create_custom_metadata(params = {}) ⇒ Struct
Adds one or more custom properties to the specified resource (a folder, document, or version).
-
#create_folder(params = {}) ⇒ Types::CreateFolderResponse
Creates a folder with the specified name and parent folder.
-
#create_labels(params = {}) ⇒ Struct
Adds the specified list of labels to the given resource (a document or folder).
-
#create_notification_subscription(params = {}) ⇒ Types::CreateNotificationSubscriptionResponse
Configure Amazon WorkDocs to use Amazon SNS notifications.
-
#create_user(params = {}) ⇒ Types::CreateUserResponse
Creates a user in a Simple AD or Microsoft AD directory.
-
#deactivate_user(params = {}) ⇒ Struct
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
-
#delete_comment(params = {}) ⇒ Struct
Deletes the specified comment from the document version.
-
#delete_custom_metadata(params = {}) ⇒ Struct
Deletes custom metadata from the specified resource.
-
#delete_document(params = {}) ⇒ Struct
Permanently deletes the specified document and its associated metadata.
-
#delete_folder(params = {}) ⇒ Struct
Permanently deletes the specified folder and its contents.
-
#delete_folder_contents(params = {}) ⇒ Struct
Deletes the contents of the specified folder.
-
#delete_labels(params = {}) ⇒ Struct
Deletes the specified list of labels from a resource.
-
#delete_notification_subscription(params = {}) ⇒ Struct
Deletes the specified subscription from the specified organization.
-
#delete_user(params = {}) ⇒ Struct
Deletes the specified user from a Simple AD or Microsoft AD directory.
-
#describe_activities(params = {}) ⇒ Types::DescribeActivitiesResponse
Describes the user activities in a specified time period.
-
#describe_comments(params = {}) ⇒ Types::DescribeCommentsResponse
List all the comments for the specified document version.
-
#describe_document_versions(params = {}) ⇒ Types::DescribeDocumentVersionsResponse
Retrieves the document versions for the specified document.
-
#describe_folder_contents(params = {}) ⇒ Types::DescribeFolderContentsResponse
Describes the contents of the specified folder, including its documents and subfolders.
-
#describe_groups(params = {}) ⇒ Types::DescribeGroupsResponse
Describes the groups specified by the query.
-
#describe_notification_subscriptions(params = {}) ⇒ Types::DescribeNotificationSubscriptionsResponse
Lists the specified notification subscriptions.
-
#describe_resource_permissions(params = {}) ⇒ Types::DescribeResourcePermissionsResponse
Describes the permissions of a specified resource.
-
#describe_root_folders(params = {}) ⇒ Types::DescribeRootFoldersResponse
Describes the current user's special folders; the
RootFolder
and theRecycleBin
. -
#describe_users(params = {}) ⇒ Types::DescribeUsersResponse
Describes the specified users.
-
#get_current_user(params = {}) ⇒ Types::GetCurrentUserResponse
Retrieves details of the current user for whom the authentication token was generated.
-
#get_document(params = {}) ⇒ Types::GetDocumentResponse
Retrieves details of a document.
-
#get_document_path(params = {}) ⇒ Types::GetDocumentPathResponse
Retrieves the path information (the hierarchy from the root folder) for the requested document.
-
#get_document_version(params = {}) ⇒ Types::GetDocumentVersionResponse
Retrieves version metadata for the specified document.
-
#get_folder(params = {}) ⇒ Types::GetFolderResponse
Retrieves the metadata of the specified folder.
-
#get_folder_path(params = {}) ⇒ Types::GetFolderPathResponse
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
-
#get_resources(params = {}) ⇒ Types::GetResourcesResponse
Retrieves a collection of resources, including folders and documents.
-
#initiate_document_version_upload(params = {}) ⇒ Types::InitiateDocumentVersionUploadResponse
Creates a new document object and version object.
-
#remove_all_resource_permissions(params = {}) ⇒ Struct
Removes all the permissions from the specified resource.
-
#remove_resource_permission(params = {}) ⇒ Struct
Removes the permission for the specified principal from the specified resource.
-
#update_document(params = {}) ⇒ Struct
Updates the specified attributes of a document.
-
#update_document_version(params = {}) ⇒ Struct
Changes the status of the document version to ACTIVE.
-
#update_folder(params = {}) ⇒ Struct
Updates the specified attributes of the specified folder.
-
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
348 349 350 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 348 def initialize(*args) super end |
Instance Method Details
#abort_document_version_upload(params = {}) ⇒ Struct
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.
383 384 385 386 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 383 def abort_document_version_upload(params = {}, = {}) req = build_request(:abort_document_version_upload, params) req.send_request() end |
#activate_user(params = {}) ⇒ Types::ActivateUserResponse
Activates the specified user. Only active users can access Amazon WorkDocs.
433 434 435 436 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 433 def activate_user(params = {}, = {}) req = build_request(:activate_user, params) req.send_request() end |
#add_resource_permissions(params = {}) ⇒ Types::AddResourcePermissionsResponse
Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.
491 492 493 494 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 491 def (params = {}, = {}) req = build_request(:add_resource_permissions, params) req.send_request() end |
#create_comment(params = {}) ⇒ Types::CreateCommentResponse
Adds a new comment to the specified document version.
576 577 578 579 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 576 def create_comment(params = {}, = {}) req = build_request(:create_comment, params) req.send_request() end |
#create_custom_metadata(params = {}) ⇒ Struct
Adds one or more custom properties to the specified resource (a folder, document, or version).
615 616 617 618 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 615 def (params = {}, = {}) req = build_request(:create_custom_metadata, params) req.send_request() end |
#create_folder(params = {}) ⇒ Types::CreateFolderResponse
Creates a folder with the specified name and parent folder.
663 664 665 666 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 663 def create_folder(params = {}, = {}) req = build_request(:create_folder, params) req.send_request() end |
#create_labels(params = {}) ⇒ Struct
Adds the specified list of labels to the given resource (a document or folder)
695 696 697 698 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 695 def create_labels(params = {}, = {}) req = build_request(:create_labels, params) req.send_request() end |
#create_notification_subscription(params = {}) ⇒ Types::CreateNotificationSubscriptionResponse
Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.
For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide.
748 749 750 751 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 748 def create_notification_subscription(params = {}, = {}) req = build_request(:create_notification_subscription, params) req.send_request() end |
#create_user(params = {}) ⇒ Types::CreateUserResponse
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.
830 831 832 833 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 830 def create_user(params = {}, = {}) req = build_request(:create_user, params) req.send_request() end |
#deactivate_user(params = {}) ⇒ Struct
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
858 859 860 861 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 858 def deactivate_user(params = {}, = {}) req = build_request(:deactivate_user, params) req.send_request() end |
#delete_comment(params = {}) ⇒ Struct
Deletes the specified comment from the document version.
893 894 895 896 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 893 def delete_comment(params = {}, = {}) req = build_request(:delete_comment, params) req.send_request() end |
#delete_custom_metadata(params = {}) ⇒ Struct
Deletes custom metadata from the specified resource.
934 935 936 937 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 934 def (params = {}, = {}) req = build_request(:delete_custom_metadata, params) req.send_request() end |
#delete_document(params = {}) ⇒ Struct
Permanently deletes the specified document and its associated metadata.
962 963 964 965 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 962 def delete_document(params = {}, = {}) req = build_request(:delete_document, params) req.send_request() end |
#delete_folder(params = {}) ⇒ Struct
Permanently deletes the specified folder and its contents.
989 990 991 992 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 989 def delete_folder(params = {}, = {}) req = build_request(:delete_folder, params) req.send_request() end |
#delete_folder_contents(params = {}) ⇒ Struct
Deletes the contents of the specified folder.
1016 1017 1018 1019 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1016 def delete_folder_contents(params = {}, = {}) req = build_request(:delete_folder_contents, params) req.send_request() end |
#delete_labels(params = {}) ⇒ Struct
Deletes the specified list of labels from a resource.
1051 1052 1053 1054 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1051 def delete_labels(params = {}, = {}) req = build_request(:delete_labels, params) req.send_request() end |
#delete_notification_subscription(params = {}) ⇒ Struct
Deletes the specified subscription from the specified organization.
1077 1078 1079 1080 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1077 def delete_notification_subscription(params = {}, = {}) req = build_request(:delete_notification_subscription, params) req.send_request() end |
#delete_user(params = {}) ⇒ Struct
Deletes the specified user from a Simple AD or Microsoft AD directory.
1105 1106 1107 1108 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1105 def delete_user(params = {}, = {}) req = build_request(:delete_user, params) req.send_request() end |
#describe_activities(params = {}) ⇒ Types::DescribeActivitiesResponse
Describes the user activities in a specified time period.
1244 1245 1246 1247 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1244 def describe_activities(params = {}, = {}) req = build_request(:describe_activities, params) req.send_request() end |
#describe_comments(params = {}) ⇒ Types::DescribeCommentsResponse
List all the comments for the specified document version.
1317 1318 1319 1320 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1317 def describe_comments(params = {}, = {}) req = build_request(:describe_comments, params) req.send_request() end |
#describe_document_versions(params = {}) ⇒ Types::DescribeDocumentVersionsResponse
Retrieves the document versions for the specified document.
By default, only active versions are returned.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1390 def describe_document_versions(params = {}, = {}) req = build_request(:describe_document_versions, params) req.send_request() end |
#describe_folder_contents(params = {}) ⇒ Types::DescribeFolderContentsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1496 1497 1498 1499 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1496 def describe_folder_contents(params = {}, = {}) req = build_request(:describe_folder_contents, params) req.send_request() end |
#describe_groups(params = {}) ⇒ Types::DescribeGroupsResponse
Describes the groups specified by the query. Groups are defined by the underlying Active Directory.
1547 1548 1549 1550 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1547 def describe_groups(params = {}, = {}) req = build_request(:describe_groups, params) req.send_request() end |
#describe_notification_subscriptions(params = {}) ⇒ Types::DescribeNotificationSubscriptionsResponse
Lists the specified notification subscriptions.
1589 1590 1591 1592 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1589 def describe_notification_subscriptions(params = {}, = {}) req = build_request(:describe_notification_subscriptions, params) req.send_request() end |
#describe_resource_permissions(params = {}) ⇒ Types::DescribeResourcePermissionsResponse
Describes the permissions of a specified resource.
1642 1643 1644 1645 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1642 def (params = {}, = {}) req = build_request(:describe_resource_permissions, params) req.send_request() end |
#describe_root_folders(params = {}) ⇒ Types::DescribeRootFoldersResponse
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.
1705 1706 1707 1708 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1705 def describe_root_folders(params = {}, = {}) req = build_request(:describe_root_folders, params) req.send_request() end |
#describe_users(params = {}) ⇒ Types::DescribeUsersResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1800 1801 1802 1803 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1800 def describe_users(params = {}, = {}) req = build_request(:describe_users, params) req.send_request() end |
#get_current_user(params = {}) ⇒ Types::GetCurrentUserResponse
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.
1855 1856 1857 1858 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1855 def get_current_user(params = {}, = {}) req = build_request(:get_current_user, params) req.send_request() end |
#get_document(params = {}) ⇒ Types::GetDocumentResponse
Retrieves details of a document.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1917 def get_document(params = {}, = {}) req = build_request(:get_document, params) req.send_request() end |
#get_document_path(params = {}) ⇒ Types::GetDocumentPathResponse
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.
1971 1972 1973 1974 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1971 def get_document_path(params = {}, = {}) req = build_request(:get_document_path, params) req.send_request() end |
#get_document_version(params = {}) ⇒ Types::GetDocumentVersionResponse
Retrieves version metadata for the specified document.
2034 2035 2036 2037 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2034 def get_document_version(params = {}, = {}) req = build_request(:get_document_version, params) req.send_request() end |
#get_folder(params = {}) ⇒ Types::GetFolderResponse
Retrieves the metadata of the specified folder.
2085 2086 2087 2088 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2085 def get_folder(params = {}, = {}) req = build_request(:get_folder, params) req.send_request() end |
#get_folder_path(params = {}) ⇒ Types::GetFolderPathResponse
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.
2139 2140 2141 2142 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2139 def get_folder_path(params = {}, = {}) req = build_request(:get_folder_path, params) req.send_request() end |
#get_resources(params = {}) ⇒ Types::GetResourcesResponse
Retrieves a collection of resources, including folders and documents.
The only CollectionType
supported is SHARED_WITH_ME
.
2226 2227 2228 2229 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2226 def get_resources(params = {}, = {}) req = build_request(:get_resources, params) req.send_request() end |
#initiate_document_version_upload(params = {}) ⇒ Types::InitiateDocumentVersionUploadResponse
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.
2317 2318 2319 2320 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2317 def initiate_document_version_upload(params = {}, = {}) req = build_request(:initiate_document_version_upload, params) req.send_request() end |
#remove_all_resource_permissions(params = {}) ⇒ Struct
Removes all the permissions from the specified resource.
2344 2345 2346 2347 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2344 def (params = {}, = {}) req = build_request(:remove_all_resource_permissions, params) req.send_request() end |
#remove_resource_permission(params = {}) ⇒ Struct
Removes the permission for the specified principal from the specified resource.
2380 2381 2382 2383 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2380 def (params = {}, = {}) req = build_request(:remove_resource_permission, params) req.send_request() end |
#update_document(params = {}) ⇒ Struct
Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.
2421 2422 2423 2424 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2421 def update_document(params = {}, = {}) req = build_request(:update_document, params) req.send_request() end |
#update_document_version(params = {}) ⇒ Struct
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.
2461 2462 2463 2464 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2461 def update_document_version(params = {}, = {}) req = build_request(:update_document_version, params) req.send_request() end |
#update_folder(params = {}) ⇒ Struct
Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.
2503 2504 2505 2506 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2503 def update_folder(params = {}, = {}) req = build_request(:update_folder, params) req.send_request() end |
#update_user(params = {}) ⇒ Types::UpdateUserResponse
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
2585 2586 2587 2588 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2585 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |