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 Amazon Web Services accounts only from the same seller as the management
account. For example, if your organization's management account was created by Amazon
Internet Services Pvt. Ltd (AISPL), an Amazon Web Services seller in India, you can
invite only other AISPL accounts to your organization. You can't combine accounts
from AISPL and Amazon Web Services or from any other Amazon Web Services seller. For
more information, see Consolidated
billing in India.
If you receive an exception that indicates that you exceeded your account limits for
the organization or that the operation failed because your organization is still initializing,
wait one hour and then try again. If the error persists after an hour, contact Amazon Web Services Support.
If the request includes tags, then the requester must have the organizations:TagResource
permission.
This operation can be called only from the organization's management account.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Organizations.AmazonOrganizationsRequest
Amazon.Organizations.Model.InviteAccountToOrganizationRequest
Namespace: Amazon.Organizations.Model
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z
Syntax
public class InviteAccountToOrganizationRequest : AmazonOrganizationsRequest IAmazonWebServiceRequest
The InviteAccountToOrganizationRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
InviteAccountToOrganizationRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
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. |
|
|
Tags | System.Collections.Generic.List<Amazon.Organizations.Model.Tag> |
Gets and sets the property Tags.
A list of tags that you want to attach to the account when it becomes a member of
the organization. For each tag in the list, you must specify both a tag key and a
value. You can set the value to an empty string, but you can't set it to Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant. If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent. |
|
|
Target | Amazon.Organizations.Model.HandshakeParty |
Gets and sets the property Target. The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:
If you use the CLI, you can submit this as a single string, similar to the following example:
If you specify
|
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 client = new AmazonOrganizationsClient();
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 Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5