Network.AWS.Organizations.CancelHandshake

Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED .

This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.

After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that it is deleted.

Creating a Request

cancelHandshake

Arguments

:: Text

chHandshakeId

-> CancelHandshake

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

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

• chHandshakeId - The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation. The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

data CancelHandshake

See: cancelHandshake smart constructor.

Instances

Eq CancelHandshake

Methods

(==) :: CancelHandshake -> CancelHandshake -> Bool

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

Data CancelHandshake

Methods

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

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

toConstr :: CancelHandshake -> Constr

dataTypeOf :: CancelHandshake -> DataType

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

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

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

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

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

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

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

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

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

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

Read CancelHandshake

Methods

readsPrec :: Int -> ReadS CancelHandshake

readList :: ReadS [CancelHandshake]

readPrec :: ReadPrec CancelHandshake

readListPrec :: ReadPrec [CancelHandshake]

Show CancelHandshake

Methods

showsPrec :: Int -> CancelHandshake -> ShowS

show :: CancelHandshake -> String

showList :: [CancelHandshake] -> ShowS

Generic CancelHandshake

Associated Types

type Rep CancelHandshake :: * -> *

Methods

from :: CancelHandshake -> Rep CancelHandshake x

to :: Rep CancelHandshake x -> CancelHandshake

Hashable CancelHandshake

Methods

hashWithSalt :: Int -> CancelHandshake -> Int

hash :: CancelHandshake -> Int

ToJSON CancelHandshake

Methods

toJSON :: CancelHandshake -> Value

toEncoding :: CancelHandshake -> Encoding

toJSONList :: [CancelHandshake] -> Value

toEncodingList :: [CancelHandshake] -> Encoding

NFData CancelHandshake

Methods

rnf :: CancelHandshake -> ()

AWSRequest CancelHandshake

Associated Types

type Rs CancelHandshake :: *

Methods

request :: CancelHandshake -> Request CancelHandshake

response :: MonadResource m => Logger -> Service -> Proxy * CancelHandshake -> ClientResponse -> m (Response CancelHandshake)

ToQuery CancelHandshake

Methods

toQuery :: CancelHandshake -> QueryString

ToPath CancelHandshake

Methods

toPath :: CancelHandshake -> ByteString

ToHeaders CancelHandshake

Methods

toHeaders :: CancelHandshake -> [Header]

type Rep CancelHandshake

type Rep CancelHandshake = D1 (MetaData "CancelHandshake" "Network.AWS.Organizations.CancelHandshake" "amazonka-organizations-1.5.0-9d9i18lsT75IlwObP60hiK" True) (C1 (MetaCons "CancelHandshake'" PrefixI True) (S1 (MetaSel (Just Symbol "_chHandshakeId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

type Rs CancelHandshake

type Rs CancelHandshake = CancelHandshakeResponse

Request Lenses

chHandshakeId :: Lens' CancelHandshake Text

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

Destructuring the Response

cancelHandshakeResponse

Arguments

:: Int

chrsResponseStatus

-> CancelHandshakeResponse

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

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

• chrsHandshake - A structure that contains details about the handshake that you canceled.
• chrsResponseStatus - -- | The response status code.

data CancelHandshakeResponse

See: cancelHandshakeResponse smart constructor.

Instances

Eq CancelHandshakeResponse

Methods

(==) :: CancelHandshakeResponse -> CancelHandshakeResponse -> Bool

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

Data CancelHandshakeResponse

Methods

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

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

toConstr :: CancelHandshakeResponse -> Constr

dataTypeOf :: CancelHandshakeResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show CancelHandshakeResponse

Methods

showsPrec :: Int -> CancelHandshakeResponse -> ShowS

show :: CancelHandshakeResponse -> String

showList :: [CancelHandshakeResponse] -> ShowS

Generic CancelHandshakeResponse

Associated Types

type Rep CancelHandshakeResponse :: * -> *

Methods

from :: CancelHandshakeResponse -> Rep CancelHandshakeResponse x

to :: Rep CancelHandshakeResponse x -> CancelHandshakeResponse

NFData CancelHandshakeResponse

Methods

rnf :: CancelHandshakeResponse -> ()

type Rep CancelHandshakeResponse

type Rep CancelHandshakeResponse = D1 (MetaData "CancelHandshakeResponse" "Network.AWS.Organizations.CancelHandshake" "amazonka-organizations-1.5.0-9d9i18lsT75IlwObP60hiK" False) (C1 (MetaCons "CancelHandshakeResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_chrsHandshake") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Handshake))) (S1 (MetaSel (Just Symbol "_chrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

chrsHandshake :: Lens' CancelHandshakeResponse (Maybe Handshake)

A structure that contains details about the handshake that you canceled.

chrsResponseStatus :: Lens' CancelHandshakeResponse Int

• - | The response status code.