amazonka-organizations-1.6.0: Amazon Organizations SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Organizations.AcceptHandshake

Contents

Description

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.

The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, then the user must also have the iam:CreateServiceLinkedRole permission so that Organizations can create the required service-linked role named OrgsServiceLinkedRoleName . For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide .

  • 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.

Synopsis

Creating a Request

acceptHandshake Source #

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

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

  • ahHandshakeId - The unique identifier (ID) of the handshake that you want to accept. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

data AcceptHandshake Source #

See: acceptHandshake smart constructor.

Instances

Eq AcceptHandshake Source # 
Data AcceptHandshake Source # 

Methods

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

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

toConstr :: AcceptHandshake -> Constr #

dataTypeOf :: AcceptHandshake -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> AcceptHandshake -> AcceptHandshake #

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

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

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

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

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

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

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

Read AcceptHandshake Source # 
Show AcceptHandshake Source # 
Generic AcceptHandshake Source # 
Hashable AcceptHandshake Source # 
ToJSON AcceptHandshake Source # 
NFData AcceptHandshake Source # 

Methods

rnf :: AcceptHandshake -> () #

AWSRequest AcceptHandshake Source # 
ToHeaders AcceptHandshake Source # 
ToPath AcceptHandshake Source # 
ToQuery AcceptHandshake Source # 
type Rep AcceptHandshake Source # 
type Rep AcceptHandshake = D1 * (MetaData "AcceptHandshake" "Network.AWS.Organizations.AcceptHandshake" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" True) (C1 * (MetaCons "AcceptHandshake'" PrefixI True) (S1 * (MetaSel (Just Symbol "_ahHandshakeId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))
type Rs AcceptHandshake Source # 

Request Lenses

ahHandshakeId :: Lens' AcceptHandshake Text Source #

The unique identifier (ID) of the handshake that you want to accept. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

Destructuring the Response

acceptHandshakeResponse Source #

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

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

data AcceptHandshakeResponse Source #

See: acceptHandshakeResponse smart constructor.

Instances

Eq AcceptHandshakeResponse Source # 
Data AcceptHandshakeResponse Source # 

Methods

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

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

toConstr :: AcceptHandshakeResponse -> Constr #

dataTypeOf :: AcceptHandshakeResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> AcceptHandshakeResponse -> AcceptHandshakeResponse #

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

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

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

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

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

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

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

Show AcceptHandshakeResponse Source # 
Generic AcceptHandshakeResponse Source # 
NFData AcceptHandshakeResponse Source # 

Methods

rnf :: AcceptHandshakeResponse -> () #

type Rep AcceptHandshakeResponse Source # 
type Rep AcceptHandshakeResponse = D1 * (MetaData "AcceptHandshakeResponse" "Network.AWS.Organizations.AcceptHandshake" "amazonka-organizations-1.6.0-rHxjcIb8Bn6XT7VgZWDi9" False) (C1 * (MetaCons "AcceptHandshakeResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_ahrsHandshake") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Handshake))) (S1 * (MetaSel (Just Symbol "_ahrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

ahrsHandshake :: Lens' AcceptHandshakeResponse (Maybe Handshake) Source #

A structure that contains details about the accepted handshake.