使用 SDK for Python 的組織範例 (Boto3)

下列程式碼範例示範如何搭配 AWS SDK for Python (Boto3) Organizations 使用 來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然 動作會示範如何呼叫個別服務函數，但您可以在其相關案例中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

動作

AttachPolicy

下列程式碼範例示範如何使用 AttachPolicy。

Python 的 SDK (Boto3)

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

def attach_policy(policy_id, target_id, orgs_client):
    """
    Attaches a policy to a target. The target is an organization root, account, or
    organizational unit.

    :param policy_id: The ID of the policy to attach.
    :param target_id: The ID of the resources to attach the policy to.
    :param orgs_client: The Boto3 Organizations client.
    """
    try:
        orgs_client.attach_policy(PolicyId=policy_id, TargetId=target_id)
        logger.info("Attached policy %s to target %s.", policy_id, target_id)
    except ClientError:
        logger.exception(
            "Couldn't attach policy %s to target %s.", policy_id, target_id
        )
        raise

• 如需 API 詳細資訊，請參閱 AttachPolicy AWS SDK for Python (Boto3) Word 參考中的 API。

CreatePolicy

下列程式碼範例示範如何使用 CreatePolicy。

Python 的 SDK (Boto3)

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

def create_policy(name, description, content, policy_type, orgs_client):
    """
    Creates a policy.

    :param name: The name of the policy.
    :param description: The description of the policy.
    :param content: The policy content as a dict. This is converted to JSON before
                    it is sent to AWS. The specific format depends on the policy type.
    :param policy_type: The type of the policy.
    :param orgs_client: The Boto3 Organizations client.
    :return: The newly created policy.
    """
    try:
        response = orgs_client.create_policy(
            Name=name,
            Description=description,
            Content=json.dumps(content),
            Type=policy_type,
        )
        policy = response["Policy"]
        logger.info("Created policy %s.", name)
    except ClientError:
        logger.exception("Couldn't create policy %s.", name)
        raise
    else:
        return policy

• 如需 API 詳細資訊，請參閱 CreatePolicy AWS SDK for Python (Boto3) Word 參考中的 API。

DeletePolicy

下列程式碼範例示範如何使用 DeletePolicy。

Python 的 SDK (Boto3)

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

def delete_policy(policy_id, orgs_client):
    """
    Deletes a policy.

    :param policy_id: The ID of the policy to delete.
    :param orgs_client: The Boto3 Organizations client.
    """
    try:
        orgs_client.delete_policy(PolicyId=policy_id)
        logger.info("Deleted policy %s.", policy_id)
    except ClientError:
        logger.exception("Couldn't delete policy %s.", policy_id)
        raise

• 如需 API 詳細資訊，請參閱 DeletePolicy AWS SDK for Python (Boto3) Word 參考中的 API。

DescribePolicy

下列程式碼範例示範如何使用 DescribePolicy。

Python 的 SDK (Boto3)

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

def describe_policy(policy_id, orgs_client):
    """
    Describes a policy.

    :param policy_id: The ID of the policy to describe.
    :param orgs_client: The Boto3 Organizations client.
    :return: The description of the policy.
    """
    try:
        response = orgs_client.describe_policy(PolicyId=policy_id)
        policy = response["Policy"]
        logger.info("Got policy %s.", policy_id)
    except ClientError:
        logger.exception("Couldn't get policy %s.", policy_id)
        raise
    else:
        return policy

• 如需 API 詳細資訊，請參閱 DescribePolicy AWS SDK for Python (Boto3) Word 參考中的 API。

DetachPolicy

下列程式碼範例示範如何使用 DetachPolicy。

Python 的 SDK (Boto3)

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

def detach_policy(policy_id, target_id, orgs_client):
    """
    Detaches a policy from a target.

    :param policy_id: The ID of the policy to detach.
    :param target_id: The ID of the resource where the policy is currently attached.
    :param orgs_client: The Boto3 Organizations client.
    """
    try:
        orgs_client.detach_policy(PolicyId=policy_id, TargetId=target_id)
        logger.info("Detached policy %s from target %s.", policy_id, target_id)
    except ClientError:
        logger.exception(
            "Couldn't detach policy %s from target %s.", policy_id, target_id
        )
        raise

• 如需 API 詳細資訊，請參閱 DetachPolicy AWS SDK for Python (Boto3) Word 參考中的 API。

ListPolicies

下列程式碼範例示範如何使用 ListPolicies。

Python 的 SDK (Boto3)

注意

還有更多 on GitHub。尋找完整範例，並了解如何在 AWS 程式碼範例儲存庫中設定和執行。

def list_policies(policy_filter, orgs_client):
    """
    Lists the policies for the account, limited to the specified filter.

    :param policy_filter: The kind of policies to return.
    :param orgs_client: The Boto3 Organizations client.
    :return: The list of policies found.
    """
    try:
        response = orgs_client.list_policies(Filter=policy_filter)
        policies = response["Policies"]
        logger.info("Found %s %s policies.", len(policies), policy_filter)
    except ClientError:
        logger.exception("Couldn't get %s policies.", policy_filter)
        raise
    else:
        return policies

• 如需 API 詳細資訊，請參閱 ListPolicies AWS SDK for Python (Boto3) Word 參考中的 API。