AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Module: Aws::WorkDocs

Defined in:
(unknown)

Overview

This module provides a client for making API requests to Amazon WorkDocs.

Aws::WorkDocs::Client

The Client class provides one-to-one mapping for each API operation.

workdocs = Aws::WorkDocs::Client.new(region: 'us-east-1')
workdocs.operation_names
#=> [:abort_document_version_upload, :activate_user, :add_resource_permissions, :create_comment, ...]

Each API operation method accepts a hash of request parameters and returns a response object.

resp = workdocs.abort_document_version_upload(params)

See Client for more information.

Aws::WorkDocs::Errors

Errors returned from Amazon WorkDocs are defined in the Errors module and extend Errors::ServiceError.

begin
  # do stuff
rescue Aws::WorkDocs::Errors::ServiceError
  # rescues all errors returned by Amazon WorkDocs
end

See Errors for more information.

Defined Under Namespace

Modules: Errors, Types Classes: Client