aws_organizations

AWS Organizations

Summary

Functions

• accept_handshake(Client, Input)
  Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.
• accept_handshake(Client, Input, Options)
• attach_policy(Client, Input)
  Attaches a policy to a root, an organizational unit (OU), or an individual account.
• attach_policy(Client, Input, Options)
• cancel_handshake(Client, Input)
  Cancels a handshake.
• cancel_handshake(Client, Input, Options)
• create_account(Client, Input)
  Creates an AWS account that is automatically a member of the organization whose credentials made the request.
• create_account(Client, Input, Options)
• create_gov_cloud_account(Client, Input)
  This action is available if all of the following are true:.
• create_gov_cloud_account(Client, Input, Options)
• create_organization(Client, Input)
  Creates an AWS organization.
• create_organization(Client, Input, Options)
• create_organizational_unit(Client, Input)
  Creates an organizational unit (OU) within a root or parent OU.
• create_organizational_unit(Client, Input, Options)
• create_policy(Client, Input)
  Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.
• create_policy(Client, Input, Options)
• decline_handshake(Client, Input)
  Declines a handshake request.
• decline_handshake(Client, Input, Options)
• delete_organization(Client, Input)
  Deletes the organization.
• delete_organization(Client, Input, Options)
• delete_organizational_unit(Client, Input)
  Deletes an organizational unit (OU) from a root or another OU.
• delete_organizational_unit(Client, Input, Options)
• delete_policy(Client, Input)
  Deletes the specified policy from your organization.
• delete_policy(Client, Input, Options)
• deregister_delegated_administrator(Client, Input)
  Removes the specified member AWS account as a delegated administrator for the specified AWS service.
• deregister_delegated_administrator(Client, Input, Options)
• describe_account(Client, Input)
  Retrieves AWS Organizations-related information about the specified account.
• describe_account(Client, Input, Options)
• describe_create_account_status(Client, Input)
  Retrieves the current status of an asynchronous request to create an account.
• describe_create_account_status(Client, Input, Options)
• describe_effective_policy(Client, Input)
  Returns the contents of the effective policy for specified policy type and account.
• describe_effective_policy(Client, Input, Options)
• describe_handshake(Client, Input)
  Retrieves information about a previously requested handshake.
• describe_handshake(Client, Input, Options)
• describe_organization(Client, Input)
  Retrieves information about the organization that the user's account belongs to.
• describe_organization(Client, Input, Options)
• describe_organizational_unit(Client, Input)
  Retrieves information about an organizational unit (OU).
• describe_organizational_unit(Client, Input, Options)
• describe_policy(Client, Input)
  Retrieves information about a policy.
• describe_policy(Client, Input, Options)
• detach_policy(Client, Input)
  Detaches a policy from a target root, organizational unit (OU), or account.
• detach_policy(Client, Input, Options)
• disable_a_w_s_service_access(Client, Input)
  Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations.
• disable_a_w_s_service_access(Client, Input, Options)
• disable_policy_type(Client, Input)
  Disables an organizational policy type in a root.
• disable_policy_type(Client, Input, Options)
• enable_a_w_s_service_access(Client, Input)
  Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations.
• enable_a_w_s_service_access(Client, Input, Options)
• enable_all_features(Client, Input)
  Enables all features in an organization.
• enable_all_features(Client, Input, Options)
• enable_policy_type(Client, Input)
  Enables a policy type in a root.
• enable_policy_type(Client, Input, Options)
• invite_account_to_organization(Client, Input)
  Sends an invitation to another account to join your organization as a member account.
• invite_account_to_organization(Client, Input, Options)
• leave_organization(Client, Input)
  Removes a member account from its parent organization.
• leave_organization(Client, Input, Options)
• list_a_w_s_service_access_for_organization(Client, Input)
  Returns a list of the AWS services that you enabled to integrate with your organization.
• list_a_w_s_service_access_for_organization(Client, Input, Options)
• list_accounts(Client, Input)
  Lists all the accounts in the organization.
• list_accounts(Client, Input, Options)
• list_accounts_for_parent(Client, Input)
  Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU).
• list_accounts_for_parent(Client, Input, Options)
• list_children(Client, Input)
  Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root.
• list_children(Client, Input, Options)
• list_create_account_status(Client, Input)
  Lists the account creation requests that match the specified status that is currently being tracked for the organization.
• list_create_account_status(Client, Input, Options)
• list_delegated_administrators(Client, Input)
  Lists the AWS accounts that are designated as delegated administrators in this organization.
• list_delegated_administrators(Client, Input, Options)
• list_delegated_services_for_account(Client, Input)
  List the AWS services for which the specified account is a delegated administrator.
• list_delegated_services_for_account(Client, Input, Options)
• list_handshakes_for_account(Client, Input)
  Lists the current handshakes that are associated with the account of the requesting user.
• list_handshakes_for_account(Client, Input, Options)
• list_handshakes_for_organization(Client, Input)
  Lists the handshakes that are associated with the organization that the requesting user is part of.
• list_handshakes_for_organization(Client, Input, Options)
• list_organizational_units_for_parent(Client, Input)
  Lists the organizational units (OUs) in a parent organizational unit or root.
• list_organizational_units_for_parent(Client, Input, Options)
• list_parents(Client, Input)
  Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account.
• list_parents(Client, Input, Options)
• list_policies(Client, Input)
  Retrieves the list of all policies in an organization of a specified type.
• list_policies(Client, Input, Options)
• list_policies_for_target(Client, Input)
  Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account.
• list_policies_for_target(Client, Input, Options)
• list_roots(Client, Input)
  Lists the roots that are defined in the current organization.
• list_roots(Client, Input, Options)
• list_tags_for_resource(Client, Input)
  Lists tags for the specified resource.
• list_tags_for_resource(Client, Input, Options)
• list_targets_for_policy(Client, Input)
  Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.
• list_targets_for_policy(Client, Input, Options)
• move_account(Client, Input)
  Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.
• move_account(Client, Input, Options)
• register_delegated_administrator(Client, Input)
  Enables the specified member account to administer the Organizations features of the specified AWS service.
• register_delegated_administrator(Client, Input, Options)
• remove_account_from_organization(Client, Input)
  Removes the specified account from the organization.
• remove_account_from_organization(Client, Input, Options)
• tag_resource(Client, Input)
  Adds one or more tags to the specified resource.
• tag_resource(Client, Input, Options)
• untag_resource(Client, Input)
  Removes a tag from the specified resource.
• untag_resource(Client, Input, Options)
• update_organizational_unit(Client, Input)
  Renames the specified organizational unit (OU).
• update_organizational_unit(Client, Input, Options)
• update_policy(Client, Input)
  Updates an existing policy with a new name, description, or content.
• update_policy(Client, Input, Options)

Functions

Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.

This operation can be called only by the following principals when they also have the relevant IAM permissions:

• Invitation to join or Approve all features request handshakes: only a principal from the member account.

  The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, the user must also have the iam:CreateServiceLinkedRole permission so that AWS Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

• Enable all features final confirmation handshake: only a principal from the master account.

  For more information about invitations, see Inviting an AWS Account to Join Your Organization in the AWS Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the AWS Organizations User Guide for information about each policy type:

• AISERVICES_OPT_OUT_POLICY

• BACKUP_POLICY

• SERVICE_CONTROL_POLICY

• TAG_POLICY

Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED.

This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.

Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

• Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

• Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with AWS Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.

The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.

This operation can be called only from the organization's master account.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

This action is available if all of the following are true:

• You're authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide.

• You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region.

• You call this action from the master account of your organization in the commercial Region.

• You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:

• Verify that AWS CloudTrail is enabled to store logs.

• Create an S3 bucket for AWS CloudTrail log storage.

  For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide.

You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide.

Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

• Use the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

• Check the AWS CloudTrail log for the CreateAccountResult event. For information on using AWS CloudTrail with Organizations, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.

When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.

A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.

This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions.

Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.

For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide.

Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.

For more information about policies and their use, see Managing Organization Policies.

Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.

This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request.

Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts.

Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.

Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts.

Removes the specified member AWS account as a delegated administrator for the specified AWS service.

Deregistering a delegated administrator can have unintended impacts on the functionality of the enabled AWS service. See the documentation for the enabled service before you deregister a delegated administrator so that you understand any potential impacts. You can run this action only for AWS services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at AWS Services that you can use with AWS Organizations in the AWS Organizations User Guide.

Retrieves AWS Organizations-related information about the specified account.

Retrieves the current status of an asynchronous request to create an account.

Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.

This operation applies only to policy types other than service control policies (SCPs).

For more information about policy inheritance, see How Policy Inheritance Works in the AWS Organizations User Guide.

Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.

You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They're then deleted and no longer accessible.

Retrieves information about the organization that the user's account belongs to.

This operation can be called from any account in the organization.

Retrieves information about an organizational unit (OU).

Retrieves information about a policy.

Detaches a policy from a target root, organizational unit (OU), or account.

If the policy being detached is a service control policy (SCP), the changes to permissions for AWS Identity and Access Management (IAM) users and roles in affected accounts are immediate. Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an "allow list". If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify "Effect": "Deny" in the second SCP to override the "Effect": "Allow" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of a "deny list".

Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.

We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service. After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts unless the operations are explicitly permitted by the IAM policies that are attached to your roles.

For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.

This is an asynchronous request that AWS performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's master account.

Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts.

We recommend that you enable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service. For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake. After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots.

After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains "Action": "ENABLE_ALL_FEATURES". This completes the change.

After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.

Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation.

This is an asynchronous request that AWS performs in the background. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's master account.

Sends an invitation to another account to join your organization as a member account. AWS Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.

Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use RemoveAccountFromOrganization instead.

This operation can be called only from a member account in the organization.

Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.

For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation.

Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.

Lists the account creation requests that match the specified status that is currently being tracked for the organization.

Lists the AWS accounts that are designated as delegated administrators in this organization.

List the AWS services for which the specified account is a delegated administrator.

Lists the current handshakes that are associated with the account of the requesting user.

Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.

Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake.

Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.

Lists the organizational units (OUs) in a parent organizational unit or root.

Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.

Retrieves the list of all policies in an organization of a specified type.

Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.

Lists the roots that are defined in the current organization.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display. This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.

Lists tags for the specified resource.

Currently, you can list tags on an account in AWS Organizations.

Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.

Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.

Enables the specified member account to administer the Organizations features of the specified AWS service. It grants read-only access to AWS Organizations service data. The account still requires IAM permissions to access and administer the AWS service.

You can run this action only for AWS services that support this feature. For a current list of services that support it, see the column Supports Delegated Administrator in the table at AWS Services that you can use with AWS Organizations in the AWS Organizations User Guide.

Removes the specified account from the organization.

The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it's removed from the organization.

This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.

Adds one or more tags to the specified resource.

Currently, you can tag and untag accounts in AWS Organizations.

Removes a tag from the specified resource.

Currently, you can tag and untag accounts in AWS Organizations.

Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.

Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.