2024-02-16 11:17:29 -05:00
# Amazon WorkDocs code examples for the SDK for Ruby
2022-10-21 10:23:10 -06:00
## Overview
2021-10-08 16:29:35 +01:00
2024-02-16 11:17:29 -05: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
2024-02-16 11:17:29 -05: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/ ).
2022-10-21 10:23:10 -06:00
* Running the tests might result in charges to your AWS account.
2024-02-16 11:17:29 -05:00
* 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 ).
2022-10-21 10:23:10 -06:00
* 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
2024-02-16 11:17:29 -05:00
<!--custom.important.start-->
<!--custom.important.end-->
2021-10-08 16:29:35 +01:00
## Code examples
2024-02-16 11:17:29 -05:00
### Prerequisites
For prerequisites, see the [README ](../../README.md#Prerequisites ) in the `ruby` folder.
2021-10-08 16:29:35 +01:00
2024-02-16 11:17:29 -05:00
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->
2021-10-08 16:29:35 +01:00
2024-02-16 11:17:29 -05:00
### Single actions
2022-10-21 10:23:10 -06:00
2024-02-16 11:17:29 -05:00
Code excerpts that show you how to call individual service functions.
2022-10-21 10:23:10 -06:00
2024-09-25 15:25:54 -04:00
- [DescribeRootFolders ](workdocs_basics.rb#L37 )
2024-04-30 12:22:08 -07:00
- [DescribeUsers ](workdocs_basics.rb#L12 )
2022-10-21 10:23:10 -06:00
2024-02-16 11:17:29 -05:00
<!--custom.examples.start-->
<!--custom.examples.end-->
2022-10-21 10:23:10 -06:00
## Run the examples
2021-10-08 16:29:35 +01:00
2024-02-16 11:17:29 -05:00
### Instructions
<!--custom.instructions.start-->
<!--custom.instructions.end-->
2021-10-08 16:29:35 +01:00
2022-10-21 10:23:10 -06:00
### Tests
2024-02-16 11:17:29 -05:00
⚠ 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.
2023-05-19 13:23:56 -06:00
<!--custom.tests.start-->
The example code in this directory is not currently tested.
## Contribute
Code examples thrive on community contribution.
2022-10-21 10:23:10 -06:00
2023-05-19 13:23:56 -06:00
To learn more about the contributing process, see [CONTRIBUTING.md ](../../../CONTRIBUTING.md ).
<!--custom.tests.end-->
2022-10-21 10:23:10 -06:00
## Additional resources
2024-02-16 11:17:29 -05:00
- [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 )
2023-05-19 13:23:56 -06:00
<!--custom.resources.start-->
<!--custom.resources.end-->
2022-10-21 10:23:10 -06:00
2024-02-16 11:17:29 -05:00
---
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0