2023-03-31 05:36:53 -07:00
# Organizations code examples for the SDK for Python
2020-08-18 11:34:39 -07:00
2023-03-31 05:36:53 -07:00
## Overview
2020-08-18 11:34:39 -07:00
2023-03-31 05:36:53 -07:00
Shows how to use the AWS SDK for Python (Boto3) to work with AWS Organizations.
2020-08-18 11:34:39 -07:00
2023-03-31 05:36:53 -07:00
<!--custom.overview.start-->
<!--custom.overview.end-->
2020-08-18 11:34:39 -07:00
2024-01-05 10:05:03 -05:00
_ Organizations consolidates multiple AWS accounts into an organization that you create and centrally manage. _
2021-11-23 16:41:30 -08:00
## ⚠ Important
2020-08-18 11:34:39 -07:00
2024-01-05 10:05:03 -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/ ).
2023-03-31 05:36:53 -07:00
* 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 ).
<!--custom.important.start-->
<!--custom.important.end-->
## Code examples
2020-08-18 11:34:39 -07:00
2021-11-23 16:41:30 -08:00
### Prerequisites
2023-03-31 05:36:53 -07:00
For prerequisites, see the [README ](../../README.md#Prerequisites ) in the `python` folder.
Install the packages required by these examples by running the following in a virtual environment:
```
python -m pip install -r requirements.txt
```
<!--custom.prerequisites.start-->
<!--custom.prerequisites.end-->
2023-04-13 11:38:14 -07:00
### Single actions
Code excerpts that show you how to call individual service functions.
2024-04-30 12:22:08 -07:00
- [AttachPolicy ](organizations_policies.py#L99 )
- [CreatePolicy ](organizations_policies.py#L21 )
- [DeletePolicy ](organizations_policies.py#L144 )
- [DescribePolicy ](organizations_policies.py#L76 )
- [DetachPolicy ](organizations_policies.py#L122 )
- [ListPolicies ](organizations_policies.py#L53 )
2024-01-05 10:05:03 -05:00
<!--custom.examples.start-->
<!--custom.examples.end-->
2023-04-13 11:38:14 -07:00
## Run the examples
2023-03-31 05:36:53 -07:00
### Instructions
2021-11-23 16:41:30 -08:00
2023-03-31 05:36:53 -07:00
<!--custom.instructions.start-->
2020-09-01 10:20:07 -07:00
Run this example at a command prompt with the following command.
2020-08-18 11:34:39 -07:00
```
python organizations_policies.py [--target TARGET]
` ``
2023-03-31 05:36:53 -07:00
The example optionally attaches and detaches the demo policy to an AWS Organizations
2020-09-01 10:20:07 -07:00
resource, such as a root organization or account. If you want to include this in the
demo, replace ` TARGET` in the command with the ID of the resource.
2023-03-31 05:36:53 -07:00
<!--custom.instructions.end-->
2020-08-18 11:34:39 -07:00
2023-04-13 11:38:14 -07:00
2023-03-31 05:36:53 -07:00
### Tests
2020-08-18 11:34:39 -07:00
2023-03-31 05:36:53 -07:00
⚠ Running tests might result in charges to your AWS account.
2020-08-18 11:34:39 -07:00
2023-03-31 05:36:53 -07:00
To find instructions for running these tests, see the [README](../../README.md#Tests)
in the ` python` folder.
2020-08-18 11:34:39 -07:00
2023-03-31 05:36:53 -07:00
<!--custom.tests.start-->
<!--custom.tests.end-->
## Additional resources
2020-08-18 11:34:39 -07:00
2024-01-05 10:05:03 -05:00
- [Organizations User Guide ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html )
- [Organizations API Reference ](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html )
- [SDK for Python Organizations reference ](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/organizations.html )
2023-03-31 05:36:53 -07:00
<!--custom.resources.start-->
<!--custom.resources.end-->
2020-08-18 11:34:39 -07:00
---
2023-03-31 05:36:53 -07:00
2020-08-18 11:34:39 -07:00
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2023-03-31 05:36:53 -07:00
SPDX-License-Identifier: Apache-2.0