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 14 Java
# Amazon WorkDocs code examples for the SDK for Ruby
## Overview
2021-10-08 16:29:35 +01:00
Shows how to use the AWS SDK for Ruby to work with Amazon WorkDocs.
<!--custom.overview.start-->
<!--custom.overview.end-->
_Amazon WorkDocs _
## ⚠ Important
2021-10-08 16:29:35 +01:00
* Running this code might result in charges to your AWS account. For more details, see [AWS Pricing](https://aws.amazon.com/pricing/) and [Free Tier](https://aws.amazon.com/free/).
* 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
<!--custom.important.start-->
<!--custom.important.end-->
2021-10-08 16:29:35 +01:00
## Code examples
### Prerequisites
For prerequisites, see the [README](../../README.md#Prerequisites) in the `ruby` folder.
2021-10-08 16:29:35 +01:00
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->
2021-10-08 16:29:35 +01:00
### Single actions
Code excerpts that show you how to call individual service functions.
- [DescribeRootFolders](workdocs_basics.rb#L37)
- [DescribeUsers](workdocs_basics.rb#L12)
<!--custom.examples.start-->
<!--custom.examples.end-->
## Run the examples
2021-10-08 16:29:35 +01:00
### Instructions
<!--custom.instructions.start-->
<!--custom.instructions.end-->
2021-10-08 16:29:35 +01:00
### Tests
⚠ Running tests might result in charges to your AWS account.
To find instructions for running these tests, see the [README](../../README.md#Tests)
in the `ruby` folder.
<!--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
- [Amazon WorkDocs Developer Guide](https://docs.aws.amazon.com/workdocs/latest/developerguide/what_is.html)
- [Amazon WorkDocs API Reference](https://docs.aws.amazon.com/workdocs/latest/APIReference/Welcome.html)
- [SDK for Ruby Amazon WorkDocs reference](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Workdocs.html)
<!--custom.resources.start-->
<!--custom.resources.end-->
---
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0