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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to InviteAccountToOrganizationAsync.

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

Syntax

C#
public abstract InviteAccountToOrganizationResponse InviteAccountToOrganization(
         InviteAccountToOrganizationRequest request
)
Parameters
request
Type: Amazon.Organizations.Model.InviteAccountToOrganizationRequest

Container for the necessary parameters to execute the InviteAccountToOrganization service method.

Return Value
The response from the InviteAccountToOrganization service method, as returned by Organizations.

Exceptions

ExceptionCondition
AccessDeniedException You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
AWSOrganizationsNotInUseException Your account is not a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.
ConcurrentModificationException The target of the operation is currently being modified by a different request. Try again later.
DuplicateHandshakeException A handshake with the same action and target already exists. For example, if you invited an account to join your organization, the invited account might already have a pending invitation from this organization. If you intend to resend an invitation to an account, ensure that existing handshakes that might be considered duplicates are canceled or declined.
FinalizingOrganizationException AWS Organizations could not finalize the creation of your organization. Try again later. If this persists, contact AWS customer support.
HandshakeConstraintViolationException The requested operation would violate the constraint identified in the reason code. ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note: deleted and closed accounts still count toward your limit. 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. HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes you can send in one day. ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization. ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features. INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You cannot issue new invitations to join an organization while it is in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change. PAYMENT_INSTRUMENT_REQUIRED: You cannot complete the operation with an account that does not have a payment instrument, such as a credit card, associated with it. ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace. ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.
InvalidInputException The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit: INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party. INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid ARN for the organization. INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. INVALID_ENUM: You specified a value that is not valid for that parameter. INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters. INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value. MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed. MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed. MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed. MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed. IMMUTABLE_POLICY: You specified a policy that is managed by AWS and cannot be modified. INVALID_PATTERN: You provided a value that doesn't match the required pattern. INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern. INPUT_REQUIRED: You must include a value for all required parameters. INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation. MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation. MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.
ServiceException AWS Organizations can't complete your request because of an internal service error. Try again later.
TooManyRequestsException You've sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

Examples

The following example shows the admin of the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization.

To invite an account to join an organization


var response = client.InviteAccountToOrganization(new InviteAccountToOrganizationRequest 
{
    Notes = "This is a request for Juan's account to join Bill's organization",
    Target = new HandshakeParty {
        Id = "juan@example.com",
        Type = "EMAIL"
    }
});

Handshake handshake = response.Handshake;

            

Version Information

.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

See Also