Amazon WorkDocs examples using SDK for Ruby - Amazon SDK for Ruby
Actions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Amazon WorkDocs examples using SDK for Ruby

The following code examples show you how to perform actions and implement common scenarios by using the Amazon SDK for Ruby with Amazon WorkDocs.

Actions are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios and cross-service examples.

Scenarios are code examples that show you how to accomplish a specific task by calling multiple functions within the same service.

Each example includes a link to GitHub, where you can find instructions on how to set up and run the code in context.

Topics

Actions

The following code example shows how to use DescribeRootFolders.

SDK for Ruby
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the Amazon Code Examples Repository. 

  # Retrieves the root folder for a user by email
  # @param users [Array<Types::User>] A list of users selected from API response
  # @param user_email [String] The email of the user.
  def get_user_folder(users, user_email)
    user = users.find { |user| user.email_address == user_email }
    if user
      user.root_folder_id
    else
      @logger.error "Could not get root folder for user with email address #{user_email}"
      exit(1)
    end
  end

  # Describes the contents of a folder
  # @param [String] folder_id - The Id of the folder to describe.
  def describe_folder_contents(folder_id)
    resp = @client.describe_folder_contents({
                                              folder_id: folder_id, # required
                                              sort: "NAME", # accepts DATE, NAME
                                              order: "ASCENDING", # accepts ASCENDING, DESCENDING
                                            })
    resp.documents.each do |doc|
      md = doc.latest_version_metadata
      @logger.info "Name:          #{md.name}"
      @logger.info "Size (bytes):  #{md.size}"
      @logger.info "Last modified: #{doc.modified_timestamp}"
      @logger.info "Doc ID:        #{doc.id}"
      @logger.info "Version ID:    #{md.id}"
      @logger.info ""
    end
  rescue Aws::WorkDocs::Errors::ServiceError => e
    @logger.error "Error listing folder contents: #{e.message}"
    exit(1)
  end

The following code example shows how to use DescribeUsers.

SDK for Ruby
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the Amazon Code Examples Repository. 

  # Describes users within an organization
  # @param [String] org_id: The ID of the org.
  def describe_users(org_id)
    resp = @client.describe_users({
                                    organization_id: org_id,
                                    include: "ALL", # accepts ALL, ACTIVE_PENDING
                                    order: "ASCENDING", # accepts ASCENDING, DESCENDING
                                    sort: "USER_NAME", # accepts USER_NAME, FULL_NAME, STORAGE_LIMIT, USER_STATUS, STORAGE_USED
                                  })
    resp.users.each do |user|
      @logger.info "First name:  #{user.given_name}"
      @logger.info "Last name:   #{user.surname}"
      @logger.info "Email:       #{user.email_address}"
      @logger.info "Root folder: #{user.root_folder_id}"
      @logger.info ""
    end
    resp.users
  rescue Aws::WorkDocs::Errors::ServiceError => e
    @logger.error "AWS WorkDocs Service Error: #{e.message}"
    exit(1)
  end

  • For API details, see DescribeUsers in Amazon SDK for Ruby API Reference.