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.

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.

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

Inheritance Hierarchy


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


public class InviteAccountToOrganizationRequest : AmazonOrganizationsRequest

The InviteAccountToOrganizationRequest type exposes the following members



Public Property Notes System.String

Gets and sets the property Notes.

Additional information that you want to include in the generated email to the recipient account owner.

Public Property Target Amazon.Organizations.Model.HandshakeParty

Gets and sets the property Target.

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ "Type": "ACCOUNT", "Id": "<account id number>" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

--target Id=123456789012,Type=ACCOUNT

If you specify "Type": "ACCOUNT", then you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", then you must specify the email address that is associated with the account.



The following example shows the admin of the master account owned by inviting the account owned by 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 = "",
        Type = "EMAIL"

Handshake handshake = response.Handshake;


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