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.
324 325 326 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 324 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.
359 360 361 362 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 359 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.
409 410 411 412 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 409 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.
467 468 469 470 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 467 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.
552 553 554 555 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 552 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).
591 592 593 594 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 591 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.
639 640 641 642 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 639 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)
671 672 673 674 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 671 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.
724 725 726 727 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 724 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.
806 807 808 809 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 806 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.
834 835 836 837 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 834 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.
869 870 871 872 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 869 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.
910 911 912 913 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 910 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.
938 939 940 941 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 938 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.
965 966 967 968 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 965 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.
992 993 994 995 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 992 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.
1027 1028 1029 1030 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1027 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.
1053 1054 1055 1056 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1053 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.
1081 1082 1083 1084 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1081 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.
1220 1221 1222 1223 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1220 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.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1293 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.
1366 1367 1368 1369 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1366 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.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1472 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.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1523 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.
1565 1566 1567 1568 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1565 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.
1618 1619 1620 1621 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1618 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.
1681 1682 1683 1684 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1681 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.
1776 1777 1778 1779 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1776 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.
1831 1832 1833 1834 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1831 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.
1893 1894 1895 1896 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1893 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.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 1947 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.
2010 2011 2012 2013 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2010 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.
2061 2062 2063 2064 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2061 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.
2115 2116 2117 2118 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2115 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
.
2202 2203 2204 2205 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2202 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.
2293 2294 2295 2296 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2293 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.
2320 2321 2322 2323 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2320 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.
2356 2357 2358 2359 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2356 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.
2397 2398 2399 2400 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2397 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.
2437 2438 2439 2440 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2437 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.
2479 2480 2481 2482 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2479 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.
2561 2562 2563 2564 |
# File 'gems/aws-sdk-workdocs/lib/aws-sdk-workdocs/client.rb', line 2561 def update_user(params = {}, = {}) req = build_request(:update_user, params) req.send_request() end |