WorkDocs Contoh Amazon menggunakan SDK for Ruby

PDF

Contoh kode berikut menunjukkan cara melakukan tindakan dan mengimplementasikan skenario umum dengan menggunakan AWS SDK for Ruby with Amazon WorkDocs.

Tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Tindakan

DescribeRootFolders

Contoh kode berikut menunjukkan cara menggunakanDescribeRootFolders.

SDK untuk Ruby

catatan

Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara pengaturan dan menjalankannya di Repositori Contoh Kode AWS.

  # 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

• Untuk detail API, lihat DescribeRootFoldersdi Referensi AWS SDK for Ruby API.

DescribeRootFolders

Contoh kode berikut menunjukkan cara menggunakanDescribeRootFolders.

SDK untuk Ruby

catatan

Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara pengaturan dan menjalankannya di Repositori Contoh Kode AWS.

  # 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

• Untuk detail API, lihat DescribeRootFoldersdi Referensi AWS SDK for Ruby API.

DescribeUsers

Contoh kode berikut menunjukkan cara menggunakanDescribeUsers.

SDK untuk Ruby

catatan

Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara pengaturan dan menjalankannya di Repositori Contoh Kode AWS.

  # 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
                                    fields: %w[FULL_NAME STORAGE_LIMIT USER_STATUS STORAGE_USED] # Corrected field names
                                  })
    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

• Untuk detail API, lihat DescribeUsersdi Referensi AWS SDK for Ruby API.

DescribeUsers

Contoh kode berikut menunjukkan cara menggunakanDescribeUsers.

SDK untuk Ruby

catatan

Ada lebih banyak tentang GitHub. Temukan contoh lengkapnya dan pelajari cara pengaturan dan menjalankannya di Repositori Contoh Kode AWS.

  # 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
                                    fields: %w[FULL_NAME STORAGE_LIMIT USER_STATUS STORAGE_USED] # Corrected field names
                                  })
    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

• Untuk detail API, lihat DescribeUsersdi Referensi AWS SDK for Ruby API.