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.

Classes

NameDescription
Class AcceptHandshakeRequest

Container for the parameters to the AcceptHandshake operation. 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.

Class AcceptHandshakeResponse

This is the response object from the AcceptHandshake operation.

Class AccessDeniedException

Organizations exception

Class Account

Contains information about an AWS account that is a member of an organization.

Class AccountNotFoundException

Organizations exception

Class AlreadyInOrganizationException

Organizations exception

Class AttachPolicyRequest

Container for the parameters to the AttachPolicy operation. 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.

Class AttachPolicyResponse

This is the response object from the AttachPolicy operation.

Class AWSOrganizationsNotInUseException

Organizations exception

Class CancelHandshakeRequest

Container for the parameters to the CancelHandshake operation. 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.

Class CancelHandshakeResponse

This is the response object from the CancelHandshake operation.

Class Child

Contains a list of child entities, either OUs or accounts.

Class ChildNotFoundException

Organizations exception

Class ConcurrentModificationException

Organizations exception

Class ConstraintViolationException

Organizations exception

Class CreateAccountRequest

Container for the parameters to the CreateAccount operation. 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.

Class CreateAccountResponse

This is the response object from the CreateAccount operation.

Class CreateAccountStatus

Contains the status about a CreateAccount request to create an AWS account in an organization.

Class CreateAccountStatusNotFoundException

Organizations exception

Class CreateOrganizationalUnitRequest

Container for the parameters to the CreateOrganizationalUnit operation. 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.

Class CreateOrganizationalUnitResponse

This is the response object from the CreateOrganizationalUnit operation.

Class CreateOrganizationRequest

Container for the parameters to the CreateOrganization operation. 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.

Class CreateOrganizationResponse

This is the response object from the CreateOrganization operation.

Class CreatePolicyRequest

Container for the parameters to the CreatePolicy operation. 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.

Class CreatePolicyResponse

This is the response object from the CreatePolicy operation.

Class DeclineHandshakeRequest

Container for the parameters to the DeclineHandshake operation. 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.

Class DeclineHandshakeResponse

This is the response object from the DeclineHandshake operation.

Class DeleteOrganizationalUnitRequest

Container for the parameters to the DeleteOrganizationalUnit operation. 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.

Class DeleteOrganizationalUnitResponse

This is the response object from the DeleteOrganizationalUnit operation.

Class DeleteOrganizationRequest

Container for the parameters to the DeleteOrganization operation. 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.

Class DeleteOrganizationResponse

This is the response object from the DeleteOrganization operation.

Class DeletePolicyRequest

Container for the parameters to the DeletePolicy operation. 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.

Class DeletePolicyResponse

This is the response object from the DeletePolicy operation.

Class DescribeAccountRequest

Container for the parameters to the DescribeAccount operation. Retrieves Organizations-related information about the specified account.

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

Class DescribeAccountResponse

This is the response object from the DescribeAccount operation.

Class DescribeCreateAccountStatusRequest

Container for the parameters to the DescribeCreateAccountStatus operation. Retrieves the current status of an asynchronous request to create an account.

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

Class DescribeCreateAccountStatusResponse

This is the response object from the DescribeCreateAccountStatus operation.

Class DescribeHandshakeRequest

Container for the parameters to the DescribeHandshake operation. 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.

Class DescribeHandshakeResponse

This is the response object from the DescribeHandshake operation.

Class DescribeOrganizationalUnitRequest

Container for the parameters to the DescribeOrganizationalUnit operation. Retrieves information about an organizational unit (OU).

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

Class DescribeOrganizationalUnitResponse

This is the response object from the DescribeOrganizationalUnit operation.

Class DescribeOrganizationRequest

Container for the parameters to the DescribeOrganization operation. Retrieves information about the organization that the user's account belongs to.

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

Class DescribeOrganizationResponse

This is the response object from the DescribeOrganization operation.

Class DescribePolicyRequest

Container for the parameters to the DescribePolicy operation. Retrieves information about a policy.

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

Class DescribePolicyResponse

This is the response object from the DescribePolicy operation.

Class DestinationParentNotFoundException

Organizations exception

Class DetachPolicyRequest

Container for the parameters to the DetachPolicy operation. 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.

Class DetachPolicyResponse

This is the response object from the DetachPolicy operation.

Class DisablePolicyTypeRequest

Container for the parameters to the DisablePolicyType operation. 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.

Class DisablePolicyTypeResponse

This is the response object from the DisablePolicyType operation.

Class DuplicateAccountException

Organizations exception

Class DuplicateHandshakeException

Organizations exception

Class DuplicateOrganizationalUnitException

Organizations exception

Class DuplicatePolicyAttachmentException

Organizations exception

Class DuplicatePolicyException

Organizations exception

Class EnableAllFeaturesRequest

Container for the parameters to the EnableAllFeatures operation. 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.

Class EnableAllFeaturesResponse

This is the response object from the EnableAllFeatures operation.

Class EnablePolicyTypeRequest

Container for the parameters to the EnablePolicyType operation. 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.

Class EnablePolicyTypeResponse

This is the response object from the EnablePolicyType operation.

Class FinalizingOrganizationException

Organizations exception

Class Handshake

Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a master account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.

Note: Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in lists for only 30 days after entering that state After that they are deleted.

Class HandshakeAlreadyInStateException

Organizations exception

Class HandshakeConstraintViolationException

Organizations exception

Class HandshakeFilter

Specifies the criteria that are used to select the handshakes for the operation.

Class HandshakeNotFoundException

Organizations exception

Class HandshakeParty

Identifies a participant in a handshake.

Class HandshakeResource

Contains additional data that is needed to process a handshake.

Class InvalidHandshakeTransitionException

Organizations exception

Class InvalidInputException

Organizations exception

Class InviteAccountToOrganizationRequest

Container for the parameters to the InviteAccountToOrganization operation. 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.

Class InviteAccountToOrganizationResponse

This is the response object from the InviteAccountToOrganization operation.

Class LeaveOrganizationRequest

Container for the parameters to the LeaveOrganization operation. 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.

Class LeaveOrganizationResponse

This is the response object from the LeaveOrganization operation.

Class ListAccountsForParentRequest

Container for the parameters to the ListAccountsForParent operation. 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.

Class ListAccountsForParentResponse

This is the response object from the ListAccountsForParent operation.

Class ListAccountsRequest

Container for the parameters to the ListAccounts operation. 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.

Class ListAccountsResponse

This is the response object from the ListAccounts operation.

Class ListChildrenRequest

Container for the parameters to the ListChildren operation. 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.

Class ListChildrenResponse

This is the response object from the ListChildren operation.

Class ListCreateAccountStatusRequest

Container for the parameters to the ListCreateAccountStatus operation. 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.

Class ListCreateAccountStatusResponse

This is the response object from the ListCreateAccountStatus operation.

Class ListHandshakesForAccountRequest

Container for the parameters to the ListHandshakesForAccount operation. 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.

Class ListHandshakesForAccountResponse

This is the response object from the ListHandshakesForAccount operation.

Class ListHandshakesForOrganizationRequest

Container for the parameters to the ListHandshakesForOrganization operation. 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.

Class ListHandshakesForOrganizationResponse

This is the response object from the ListHandshakesForOrganization operation.

Class ListOrganizationalUnitsForParentRequest

Container for the parameters to the ListOrganizationalUnitsForParent operation. Lists the organizational units (OUs) in a parent organizational unit or root.

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

Class ListOrganizationalUnitsForParentResponse

This is the response object from the ListOrganizationalUnitsForParent operation.

Class ListParentsRequest

Container for the parameters to the ListParents operation. 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.

Class ListParentsResponse

This is the response object from the ListParents operation.

Class ListPoliciesForTargetRequest

Container for the parameters to the ListPoliciesForTarget operation. 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.

Class ListPoliciesForTargetResponse

This is the response object from the ListPoliciesForTarget operation.

Class ListPoliciesRequest

Container for the parameters to the ListPolicies operation. 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.

Class ListPoliciesResponse

This is the response object from the ListPolicies operation.

Class ListRootsRequest

Container for the parameters to the ListRoots operation. Lists the roots that are defined in the current organization.

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

Class ListRootsResponse

This is the response object from the ListRoots operation.

Class ListTargetsForPolicyRequest

Container for the parameters to the ListTargetsForPolicy operation. 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.

Class ListTargetsForPolicyResponse

This is the response object from the ListTargetsForPolicy operation.

Class MalformedPolicyDocumentException

Organizations exception

Class MasterCannotLeaveOrganizationException

Organizations exception

Class MoveAccountRequest

Container for the parameters to the MoveAccount operation. 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.

Class MoveAccountResponse

This is the response object from the MoveAccount operation.

Class Organization

Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .

Class OrganizationalUnit

Contains details about an organizational unit (OU). An OU is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.

Class OrganizationalUnitNotEmptyException

Organizations exception

Class OrganizationalUnitNotFoundException

Organizations exception

Class OrganizationNotEmptyException

Organizations exception

Class Parent

Contains information about either a root or an organizational unit (OU) that can contain OUs or accounts in an organization.

Class ParentNotFoundException

Organizations exception

Class Policy

Contains rules to be applied to the affected accounts. Policies can be attached directly to accounts, or to roots and OUs to affect all accounts in those hierarchies.

Class PolicyInUseException

Organizations exception

Class PolicyNotAttachedException

Organizations exception

Class PolicyNotFoundException

Organizations exception

Class PolicySummary

Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.

Class PolicyTargetSummary

Contains information about a root, OU, or account that a policy is attached to.

Class PolicyTypeAlreadyEnabledException

Organizations exception

Class PolicyTypeNotAvailableForOrganizationException

Organizations exception

Class PolicyTypeNotEnabledException

Organizations exception

Class PolicyTypeSummary

Contains information about a policy type and its status in the associated root.

Class RemoveAccountFromOrganizationRequest

Container for the parameters to the RemoveAccountFromOrganization operation. 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.

Class RemoveAccountFromOrganizationResponse

This is the response object from the RemoveAccountFromOrganization operation.

Class Root

Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. Every root contains every AWS account in the organization. Each root enables the accounts to be organized in a different way and to have different policy types enabled for use in that root.

Class RootNotFoundException

Organizations exception

Class ServiceException

Organizations exception

Class SourceParentNotFoundException

Organizations exception

Class TargetNotFoundException

Organizations exception

Class TooManyRequestsException

Organizations exception

Class UpdateOrganizationalUnitRequest

Container for the parameters to the UpdateOrganizationalUnit operation. 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.

Class UpdateOrganizationalUnitResponse

This is the response object from the UpdateOrganizationalUnit operation.

Class UpdatePolicyRequest

Container for the parameters to the UpdatePolicy operation. 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.

Class UpdatePolicyResponse

This is the response object from the UpdatePolicy operation.