SIGN IN SIGN UP

Welcome to the AWS Code Examples Repository. This repo contains code examples used in the AWS documentation, AWS SDK Developer Guides, and more. For more information, see the Readme.md file below.

0 0 226 Java
# WorkDocs code examples for the SDK for Ruby
## Overview
These examples show how to create and manage Amazon WorkDocs resources using the SDK for Ruby.
2021-10-08 16:29:35 +01:00
WorkDocs is a fully managed, secure enterprise storage and sharing service with strong administrative controls and feedback capabilities that improve user productivity.
2021-10-08 16:29:35 +01:00
## ⚠️ Important
* Running this code might result in charges to your AWS account.
* Running the tests might result in charges to your AWS account.
* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
2021-10-08 16:29:35 +01:00
## Code examples
### Single actions
Code excerpts that show you how to call individual service functions.
2021-10-08 16:29:35 +01:00
* [List a user's documents](./wd_list_user_docs.rb) (`GetDocuments`)
2021-10-08 16:29:35 +01:00
* [List users](./wd_list_users.rb) (`DescribeUsers`)
2021-10-08 16:29:35 +01:00
## Run the examples
2021-10-08 16:29:35 +01:00
2021-10-13 19:30:48 +01:00
### Prerequisites
2021-10-08 16:29:35 +01:00
See the [Ruby README.md](../../../ruby/README.md) for prerequisites.
### Instructions
The easiest way to interact with this example code is by invoking [Single Actions](#single-actions) from your command line. This may require some modification to override hard-coded values, and some actions also expect runtime parameters. For example, `ruby some_action.rb ARG1 ARG2` will invoke `some_action.rb` with two arguments.
### Tests
<!--custom.tests.start-->
The example code in this directory is not currently tested.
## Contribute
Code examples thrive on community contribution.
To learn more about the contributing process, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
<!--custom.tests.end-->
## Additional resources
<!--custom.resources.start-->
* [SDK for Ruby Developer Guide](https://aws.amazon.com/developer/language/ruby/)
* [SDK for Ruby Amazon WorkDocs Module](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkDocs.html)
* [WorkDocs Developer Guide](https://docs.aws.amazon.com/workdocs/latest/developerguide/what_is.html)
* [WorkDocs API Reference](https://docs.aws.amazon.com/workdocs/latest/APIReference/Welcome.html)
<!--custom.resources.end-->
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. SPDX-License-Identifier: Apache-2.0