Network.AWS.Organizations.InviteAccountToOrganization

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.

Important: 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.

Important: 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 .

Creating a Request

inviteAccountToOrganization

Arguments

:: HandshakeParty

iatoTarget

-> InviteAccountToOrganization

Creates a value of InviteAccountToOrganization with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• iatoNotes - Additional information that you want to include in the generated email to the recipient account owner.
• iatoTarget - 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: "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. --target Id=billexample.com,Type=EMAIL@

data InviteAccountToOrganization

See: inviteAccountToOrganization smart constructor.

Instances

Eq InviteAccountToOrganization

Methods

(==) :: InviteAccountToOrganization -> InviteAccountToOrganization -> Bool

(/=) :: InviteAccountToOrganization -> InviteAccountToOrganization -> Bool

Data InviteAccountToOrganization

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InviteAccountToOrganization -> c InviteAccountToOrganization

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InviteAccountToOrganization

toConstr :: InviteAccountToOrganization -> Constr

dataTypeOf :: InviteAccountToOrganization -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c InviteAccountToOrganization)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InviteAccountToOrganization)

gmapT :: (forall b. Data b => b -> b) -> InviteAccountToOrganization -> InviteAccountToOrganization

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InviteAccountToOrganization -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InviteAccountToOrganization -> r

gmapQ :: (forall d. Data d => d -> u) -> InviteAccountToOrganization -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InviteAccountToOrganization -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InviteAccountToOrganization -> m InviteAccountToOrganization

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InviteAccountToOrganization -> m InviteAccountToOrganization

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InviteAccountToOrganization -> m InviteAccountToOrganization

Show InviteAccountToOrganization

Methods

showsPrec :: Int -> InviteAccountToOrganization -> ShowS

show :: InviteAccountToOrganization -> String

showList :: [InviteAccountToOrganization] -> ShowS

Generic InviteAccountToOrganization

Associated Types

type Rep InviteAccountToOrganization :: * -> *

Methods

from :: InviteAccountToOrganization -> Rep InviteAccountToOrganization x

to :: Rep InviteAccountToOrganization x -> InviteAccountToOrganization

Hashable InviteAccountToOrganization

Methods

hashWithSalt :: Int -> InviteAccountToOrganization -> Int

hash :: InviteAccountToOrganization -> Int

ToJSON InviteAccountToOrganization

Methods

toJSON :: InviteAccountToOrganization -> Value

toEncoding :: InviteAccountToOrganization -> Encoding

toJSONList :: [InviteAccountToOrganization] -> Value

toEncodingList :: [InviteAccountToOrganization] -> Encoding

NFData InviteAccountToOrganization

Methods

rnf :: InviteAccountToOrganization -> ()

AWSRequest InviteAccountToOrganization

Associated Types

type Rs InviteAccountToOrganization :: *

Methods

request :: InviteAccountToOrganization -> Request InviteAccountToOrganization

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * InviteAccountToOrganization -> ClientResponse -> m (Response InviteAccountToOrganization)

ToHeaders InviteAccountToOrganization

Methods

toHeaders :: InviteAccountToOrganization -> [Header]

ToPath InviteAccountToOrganization

Methods

toPath :: InviteAccountToOrganization -> ByteString

ToQuery InviteAccountToOrganization

Methods

toQuery :: InviteAccountToOrganization -> QueryString

type Rep InviteAccountToOrganization

type Rep InviteAccountToOrganization = D1 * (MetaData "InviteAccountToOrganization" "Network.AWS.Organizations.InviteAccountToOrganization" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "InviteAccountToOrganization'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_iatoNotes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Sensitive Text)))) (S1 * (MetaSel (Just Symbol "_iatoTarget") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * HandshakeParty))))

type Rs InviteAccountToOrganization

type Rs InviteAccountToOrganization = InviteAccountToOrganizationResponse

Request Lenses

iatoNotes :: Lens' InviteAccountToOrganization (Maybe Text)

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

iatoTarget :: Lens' InviteAccountToOrganization HandshakeParty

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: "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. --target Id=billexample.com,Type=EMAIL@

Destructuring the Response

inviteAccountToOrganizationResponse

Arguments

:: Int

iatorsResponseStatus

-> InviteAccountToOrganizationResponse

Creates a value of InviteAccountToOrganizationResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• iatorsHandshake - A structure that contains details about the handshake that is created to support this invitation request.
• iatorsResponseStatus - -- | The response status code.

data InviteAccountToOrganizationResponse

See: inviteAccountToOrganizationResponse smart constructor.

Instances

Eq InviteAccountToOrganizationResponse

Methods

(==) :: InviteAccountToOrganizationResponse -> InviteAccountToOrganizationResponse -> Bool

(/=) :: InviteAccountToOrganizationResponse -> InviteAccountToOrganizationResponse -> Bool

Data InviteAccountToOrganizationResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> InviteAccountToOrganizationResponse -> c InviteAccountToOrganizationResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c InviteAccountToOrganizationResponse

toConstr :: InviteAccountToOrganizationResponse -> Constr

dataTypeOf :: InviteAccountToOrganizationResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c InviteAccountToOrganizationResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c InviteAccountToOrganizationResponse)

gmapT :: (forall b. Data b => b -> b) -> InviteAccountToOrganizationResponse -> InviteAccountToOrganizationResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> InviteAccountToOrganizationResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> InviteAccountToOrganizationResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> InviteAccountToOrganizationResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> InviteAccountToOrganizationResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> InviteAccountToOrganizationResponse -> m InviteAccountToOrganizationResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> InviteAccountToOrganizationResponse -> m InviteAccountToOrganizationResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> InviteAccountToOrganizationResponse -> m InviteAccountToOrganizationResponse

Show InviteAccountToOrganizationResponse

Methods

showsPrec :: Int -> InviteAccountToOrganizationResponse -> ShowS

show :: InviteAccountToOrganizationResponse -> String

showList :: [InviteAccountToOrganizationResponse] -> ShowS

Generic InviteAccountToOrganizationResponse

Associated Types

type Rep InviteAccountToOrganizationResponse :: * -> *

Methods

from :: InviteAccountToOrganizationResponse -> Rep InviteAccountToOrganizationResponse x

to :: Rep InviteAccountToOrganizationResponse x -> InviteAccountToOrganizationResponse

NFData InviteAccountToOrganizationResponse

Methods

rnf :: InviteAccountToOrganizationResponse -> ()

type Rep InviteAccountToOrganizationResponse

type Rep InviteAccountToOrganizationResponse = D1 * (MetaData "InviteAccountToOrganizationResponse" "Network.AWS.Organizations.InviteAccountToOrganization" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "InviteAccountToOrganizationResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_iatorsHandshake") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Handshake))) (S1 * (MetaSel (Just Symbol "_iatorsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

iatorsHandshake :: Lens' InviteAccountToOrganizationResponse (Maybe Handshake)

A structure that contains details about the handshake that is created to support this invitation request.

iatorsResponseStatus :: Lens' InviteAccountToOrganizationResponse Int

• - | The response status code.