AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing Organizations AWS Organizations API Reference

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

This guide provides descriptions of the Organizations API. For more information about using this service, see the AWS Organizations User Guide.

API Version

This version of the Organizations API Reference documents the Organizations API version 2016-11-28.

As an alternative to using the API directly, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, and more). The SDKs provide a convenient way to create programmatic access to AWS Organizations. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the AWS SDKs to make programmatic API calls to Organizations. However, you also can use the Organizations Query API to make direct calls to the Organizations web service. To learn more about the Organizations Query API, see Making Query Requests in the AWS Organizations User Guide. Organizations supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Signing Requests

When you send HTTP requests to AWS, you must sign the requests so that AWS can identify who sent them. You sign requests with your AWS access key, which consists of an access key ID and a secret access key. We strongly recommend that you do not create an access key for your root account. Anyone who has the access key for your root account has unrestricted access to all the resources in your account. Instead, create an access key for an IAM user account that has administrative privileges. As another option, use AWS Security Token Service to generate temporary security credentials, and use those credentials to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.

When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools.

In this release, each organization can have only one root. In a future release, a single organization will support multiple roots.

Support and Feedback for AWS Organizations

We welcome your feedback. Send your comments to feedback-awsorganizations@amazon.com or post your feedback and questions in our private AWS Organizations support forum. If you don't have access to the forum, send a request for access to the email address, along with your forum user ID. For more information about the AWS support forums, see Forums Help.

Endpoint to Call When Using the CLI or the AWS API

For the current release of Organizations, you must specify the us-east-1 region for all AWS API and CLI calls. You can do this in the CLI by using these parameters and commands:

For the various SDKs used to call the APIs, see the documentation for the SDK of interest to learn how to direct the requests to a specific endpoint. For more information, see Regions and Endpoints in the AWS General Reference.

How examples are presented

The JSON returned by the AWS Organizations service as response to your requests is returned as a single long string without line breaks or formatting whitespace. Both line breaks and whitespace are included in the examples in this guide to improve readability. When example input parameters also would result in long strings that would extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.

Recording API Requests

AWS Organizations supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by AWS CloudTrail, you can determine which requests were successfully made to Organizations, who made the request, when it was made, and so on. For more about AWS Organizations and its support for AWS CloudTrail, see Logging AWS Organizations Events with AWS CloudTrail in the AWS Organizations User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.Organizations.AmazonOrganizationsClient

Namespace: Amazon.Organizations
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonOrganizationsClient : AmazonServiceClient
         IAmazonOrganizations, IAmazonService, IDisposable

The AmazonOrganizationsClient type exposes the following members

Constructors

NameDescription
Public Method AmazonOrganizationsClient()

Constructs AmazonOrganizationsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonOrganizationsClient(RegionEndpoint)

Constructs AmazonOrganizationsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonOrganizationsClient(AmazonOrganizationsConfig)

Constructs AmazonOrganizationsClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonOrganizationsClient(AWSCredentials)

Constructs AmazonOrganizationsClient with AWS Credentials

Public Method AmazonOrganizationsClient(AWSCredentials, RegionEndpoint)

Constructs AmazonOrganizationsClient with AWS Credentials

Public Method AmazonOrganizationsClient(AWSCredentials, AmazonOrganizationsConfig)

Constructs AmazonOrganizationsClient with AWS Credentials and an AmazonOrganizationsClient Configuration object.

Public Method AmazonOrganizationsClient(string, string)

Constructs AmazonOrganizationsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonOrganizationsClient(string, string, RegionEndpoint)

Constructs AmazonOrganizationsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonOrganizationsClient(string, string, AmazonOrganizationsConfig)

Constructs AmazonOrganizationsClient with AWS Access Key ID, AWS Secret Key and an AmazonOrganizationsClient Configuration object.

Public Method AmazonOrganizationsClient(string, string, string)

Constructs AmazonOrganizationsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonOrganizationsClient(string, string, string, RegionEndpoint)

Constructs AmazonOrganizationsClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonOrganizationsClient(string, string, string, AmazonOrganizationsConfig)

Constructs AmazonOrganizationsClient with AWS Access Key ID, AWS Secret Key and an AmazonOrganizationsClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AcceptHandshake(AcceptHandshakeRequest)

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.

  • 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.

After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.

Public Method AcceptHandshakeAsync(AcceptHandshakeRequest, CancellationToken)

Initiates the asynchronous execution of the AcceptHandshake operation.

Public Method AttachPolicy(AttachPolicyRequest)

Attaches a policy to a root, an organizational unit, or an individual account. How the policy affects accounts depends on the type of policy:

  • Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:

    • If you attach an SCP to a root, it affects all accounts in the organization.

    • If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.

    • If you attach the policy directly to an account, then it affects only that account.

    SCPs essentially are permission "filters". When you attach one SCP to a higher level root or OU, and you also attach a different SCP to a child OU or to an account, the child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child cannot grant a permission that is not already granted by the parent. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They cannot use A or B because they were filtered out by the child OU. They also cannot use F and G because they were filtered out by the parent OU. They cannot be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.

    AWS Organizations attaches a default SCP named "FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.

    For more information about how Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.

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

Public Method AttachPolicyAsync(AttachPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the AttachPolicy operation.

Public Method CancelHandshake(CancelHandshakeRequest)

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.

After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.

Public Method CancelHandshakeAsync(CancelHandshakeRequest, CancellationToken)

Initiates the asynchronous execution of the CancelHandshake operation.

Public Method CreateAccount(CreateAccountRequest)

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. If you want to check the status of the request later, you need the OperationId response element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.

AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants administrator permissions to the new 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.

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

When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the End User Licence Agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable this, then only the account root user can access billing information. For information about how to disable this for an account, see Granting Access to Your Billing Information and Tools.

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

If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.

Public Method CreateAccountAsync(CreateAccountRequest, CancellationToken)

Initiates the asynchronous execution of the CreateAccount operation.

Public Method CreateOrganization(CreateOrganizationRequest)

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.

By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING", then no policy types are enabled by default and you cannot use organization policies.

Public Method CreateOrganizationalUnit(CreateOrganizationalUnitRequest)

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.

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

Public Method CreateOrganizationalUnitAsync(CreateOrganizationalUnitRequest, CancellationToken)

Initiates the asynchronous execution of the CreateOrganizationalUnit operation.

Public Method CreateOrganizationAsync(CreateOrganizationRequest, CancellationToken)

Initiates the asynchronous execution of the CreateOrganization operation.

Public Method CreatePolicy(CreatePolicyRequest)

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.

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

Public Method CreatePolicyAsync(CreatePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the CreatePolicy operation.

Public Method DeclineHandshake(DeclineHandshakeRequest)

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 re-initiate the process with a new handshake request.

After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.

Public Method DeclineHandshakeAsync(DeclineHandshakeRequest, CancellationToken)

Initiates the asynchronous execution of the DeclineHandshake operation.

Public Method DeleteOrganization(DeleteOrganizationRequest)

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

Public Method DeleteOrganizationalUnit(DeleteOrganizationalUnitRequest)

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

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

Public Method DeleteOrganizationalUnitAsync(DeleteOrganizationalUnitRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteOrganizationalUnit operation.

Public Method DeleteOrganizationAsync(DeleteOrganizationRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteOrganization operation.

Public Method DeletePolicy(DeletePolicyRequest)

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

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

Public Method DeletePolicyAsync(DeletePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DeletePolicy operation.

Public Method DescribeAccount(DescribeAccountRequest)

Retrieves Organizations-related information about the specified account.

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

Public Method DescribeAccountAsync(DescribeAccountRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeAccount operation.

Public Method DescribeCreateAccountStatus(DescribeCreateAccountStatusRequest)

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

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

Public Method DescribeCreateAccountStatusAsync(DescribeCreateAccountStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeCreateAccountStatus operation.

Public Method DescribeHandshake(DescribeHandshakeRequest)

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 are then deleted and no longer accessible.

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

Public Method DescribeHandshakeAsync(DescribeHandshakeRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeHandshake operation.

Public Method DescribeOrganization(DescribeOrganizationRequest)

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

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

Public Method DescribeOrganizationalUnit(DescribeOrganizationalUnitRequest)

Retrieves information about an organizational unit (OU).

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

Public Method DescribeOrganizationalUnitAsync(DescribeOrganizationalUnitRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeOrganizationalUnit operation.

Public Method DescribeOrganizationAsync(DescribeOrganizationRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeOrganization operation.

Public Method DescribePolicy(DescribePolicyRequest)

Retrieves information about a policy.

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

Public Method DescribePolicyAsync(DescribePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DescribePolicy operation.

Public Method DetachPolicy(DetachPolicyRequest)

Detaches a policy from a target root, organizational unit, or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.

Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, then you must attach the replacement policy before you can remove the default one. This is the authorization strategy of whitelisting. 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), then you are using the authorization strategy of blacklisting.

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

Public Method DetachPolicyAsync(DetachPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the DetachPolicy operation.

Public Method DisablePolicyType(DisablePolicyTypeRequest)

Disables an organizational control 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 OU or account in that root. You can undo this by using the EnablePolicyType operation.

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

Public Method DisablePolicyTypeAsync(DisablePolicyTypeRequest, CancellationToken)

Initiates the asynchronous execution of the DisablePolicyType operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method EnableAllFeatures(EnableAllFeaturesRequest)

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, or that were migrated from a Consolidated Billing account family to Organizations. 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 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.

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

Public Method EnableAllFeaturesAsync(EnableAllFeaturesRequest, CancellationToken)

Initiates the asynchronous execution of the EnableAllFeatures operation.

Public Method EnablePolicyType(EnablePolicyTypeRequest)

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 OU, or account in that root. You can undo this by using the DisablePolicyType operation.

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

Public Method EnablePolicyTypeAsync(EnablePolicyTypeRequest, CancellationToken)

Initiates the asynchronous execution of the EnablePolicyType operation.

Public Method InviteAccountToOrganization(InviteAccountToOrganizationRequest)

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.

You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, then you can only invite other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS, or any other AWS seller. For more information, see Consolidated Billing in India.

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

If you get an exception that indicates that you exceeded your account limits for the organization or that you can"t add an account because your organization is still initializing, please contact AWS Customer Support.

Public Method InviteAccountToOrganizationAsync(InviteAccountToOrganizationRequest, CancellationToken)

Initiates the asynchronous execution of the InviteAccountToOrganization operation.

Public Method LeaveOrganization(LeaveOrganizationRequest)

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.

  • The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do, including preventing them from successfully calling LeaveOrganization and leaving the organization.

  • You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

Public Method LeaveOrganizationAsync(LeaveOrganizationRequest, CancellationToken)

Initiates the asynchronous execution of the LeaveOrganization operation.

Public Method ListAccounts(ListAccountsRequest)

Lists all the accounts in the organization. To request only the accounts in a root or OU, use the ListAccountsForParent operation instead.

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

Public Method ListAccountsAsync(ListAccountsRequest, CancellationToken)

Initiates the asynchronous execution of the ListAccounts operation.

Public Method ListAccountsForParent(ListAccountsForParentRequest)

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 are not 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.

Public Method ListAccountsForParentAsync(ListAccountsForParentRequest, CancellationToken)

Initiates the asynchronous execution of the ListAccountsForParent operation.

Public Method ListChildren(ListChildrenRequest)

Lists all of the 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.

Public Method ListChildrenAsync(ListChildrenRequest, CancellationToken)

Initiates the asynchronous execution of the ListChildren operation.

Public Method ListCreateAccountStatus(ListCreateAccountStatusRequest)

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

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

Public Method ListCreateAccountStatusAsync(ListCreateAccountStatusRequest, CancellationToken)

Initiates the asynchronous execution of the ListCreateAccountStatus operation.

Public Method ListHandshakesForAccount(ListHandshakesForAccountRequest)

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 are deleted and no longer accessible.

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

Public Method ListHandshakesForAccountAsync(ListHandshakesForAccountRequest, CancellationToken)

Initiates the asynchronous execution of the ListHandshakesForAccount operation.

Public Method ListHandshakesForOrganization(ListHandshakesForOrganizationRequest)

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 are deleted and no longer accessible.

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

Public Method ListHandshakesForOrganizationAsync(ListHandshakesForOrganizationRequest, CancellationToken)

Initiates the asynchronous execution of the ListHandshakesForOrganization operation.

Public Method ListOrganizationalUnitsForParent(ListOrganizationalUnitsForParentRequest)

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

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

Public Method ListOrganizationalUnitsForParentAsync(ListOrganizationalUnitsForParentRequest, CancellationToken)

Initiates the asynchronous execution of the ListOrganizationalUnitsForParent operation.

Public Method ListParents(ListParentsRequest)

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.

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

In the current release, a child can have only a single parent.

Public Method ListParentsAsync(ListParentsRequest, CancellationToken)

Initiates the asynchronous execution of the ListParents operation.

Public Method ListPolicies(ListPoliciesRequest)

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

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

Public Method ListPoliciesAsync(ListPoliciesRequest, CancellationToken)

Initiates the asynchronous execution of the ListPolicies operation.

Public Method ListPoliciesForTarget(ListPoliciesForTargetRequest)

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.

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

Public Method ListPoliciesForTargetAsync(ListPoliciesForTargetRequest, CancellationToken)

Initiates the asynchronous execution of the ListPoliciesForTarget operation.

Public Method ListRoots(ListRootsRequest)

Lists the roots that are defined in the current organization.

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

Public Method ListRootsAsync(ListRootsRequest, CancellationToken)

Initiates the asynchronous execution of the ListRoots operation.

Public Method ListTargetsForPolicy(ListTargetsForPolicyRequest)

Lists all the roots, OUs, and accounts to which the specified policy is attached.

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

Public Method ListTargetsForPolicyAsync(ListTargetsForPolicyRequest, CancellationToken)

Initiates the asynchronous execution of the ListTargetsForPolicy operation.

Public Method MoveAccount(MoveAccountRequest)

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

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

Public Method MoveAccountAsync(MoveAccountRequest, CancellationToken)

Initiates the asynchronous execution of the MoveAccount operation.

Public Method RemoveAccountFromOrganization(RemoveAccountFromOrganizationRequest)

Removes the specified account from the organization.

The removed account becomes a stand-alone account that is not a member of any organization. It is 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 is removed from the organization.

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

  • You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the End User License Agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account is not attached to an organization. To remove an account that does not yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • You can remove a member account only after you enable IAM user access to billing in the member account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

Public Method RemoveAccountFromOrganizationAsync(RemoveAccountFromOrganizationRequest, CancellationToken)

Initiates the asynchronous execution of the RemoveAccountFromOrganization operation.

Public Method UpdateOrganizationalUnit(UpdateOrganizationalUnitRequest)

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

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

Public Method UpdateOrganizationalUnitAsync(UpdateOrganizationalUnitRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateOrganizationalUnit operation.

Public Method UpdatePolicy(UpdatePolicyRequest)

Updates an existing policy with a new name, description, or content. If any parameter is not supplied, that value remains unchanged. Note that you cannot change a policy's type.

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

Public Method UpdatePolicyAsync(UpdatePolicyRequest, CancellationToken)

Initiates the asynchronous execution of the UpdatePolicy operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms