Package-level declarations

Types

Link copied to clipboard

Organizations is a web service that enables you to consolidate your multiple Amazon Web Services accounts into an organization and centrally manage your accounts and their resources.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard

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

Link copied to clipboard

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 Organizations User Guide for information about each policy type:

Link copied to clipboard

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

Link copied to clipboard

Closes an Amazon Web Services member account within an organization. You can close an account when all features are enabled . You can't close the management account with this API. This is an asynchronous request that Amazon Web Services performs in the background. Because CloseAccount operates asynchronously, it can return a successful completion message even though account closure might still be in progress. You need to wait a few minutes before the account is fully closed. To check the status of the request, do one of the following:

Link copied to clipboard

Creates an Amazon Web Services account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that Amazon Web Services 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:

Link copied to clipboard

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

Link copied to clipboard

Creates an Amazon Web Services organization. The account whose user is calling the CreateOrganization operation automatically becomes the management account of the new organization.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Deletes the resource policy from your organization.

Link copied to clipboard

Removes the specified member Amazon Web Services account as a delegated administrator for the specified Amazon Web Services service.

Link copied to clipboard

Retrieves Organizations-related information about the specified account.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Retrieves information about an organizational unit (OU).

Link copied to clipboard

Retrieves information about a policy.

Link copied to clipboard

Retrieves information about a resource policy.

Link copied to clipboard

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

Link copied to clipboard

Disables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with 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 Organizations.

Link copied to clipboard

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.

Link copied to clipboard

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 Organizations supports. For more information, see Enabling all features in your organization in the Organizations User Guide.

Link copied to clipboard

Enables the integration of an Amazon Web Services service (the service that is specified by ServicePrincipal) with 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.

Link copied to clipboard

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.

Link copied to clipboard

Sends an invitation to another account to join your organization as a member account. 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.

Link copied to clipboard

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 management account, use RemoveAccountFromOrganization instead.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of the Amazon Web Services 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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Lists the Amazon Web Services accounts that are designated as delegated administrators in this organization.

Link copied to clipboard

List the Amazon Web Services services for which the specified account is a delegated administrator.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun OrganizationsClient.listRoots(crossinline block: ListRootsRequest.Builder.() -> Unit): ListRootsResponse

Lists the roots that are defined in the current organization.

Link copied to clipboard

Lists tags that are attached to the specified resource.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Creates or updates a resource policy.

Link copied to clipboard

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

Link copied to clipboard

Removes the specified account from the organization.

Link copied to clipboard

Adds one or more tags to the specified resource.

Link copied to clipboard

Removes any tags with the specified keys from the specified resource.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.