Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Organizations.CancelHandshake

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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's deleted.

Creating a Request

data CancelHandshake Source #

See: newCancelHandshake smart constructor.

Constructors

CancelHandshake'
Fields handshakeId :: 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 lowercase letters or digits.

Instances

Instances details

ToJSON CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods toJSON :: CancelHandshake -> Value # toEncoding :: CancelHandshake -> Encoding # toJSONList :: [CancelHandshake] -> Value # toEncodingList :: [CancelHandshake] -> Encoding #
ToHeaders CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods toHeaders :: CancelHandshake -> [Header] #
ToPath CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods toPath :: CancelHandshake -> ByteString #
ToQuery CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods toQuery :: CancelHandshake -> QueryString #
AWSRequest CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Associated Types type AWSResponse CancelHandshake # Methods request :: (Service -> Service) -> CancelHandshake -> Request CancelHandshake # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CancelHandshake -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CancelHandshake))) #
Generic CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Associated Types type Rep CancelHandshake :: Type -> Type # Methods from :: CancelHandshake -> Rep CancelHandshake x # to :: Rep CancelHandshake x -> CancelHandshake #
Read CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods readsPrec :: Int -> ReadS CancelHandshake # readList :: ReadS [CancelHandshake] # readPrec :: ReadPrec CancelHandshake # readListPrec :: ReadPrec [CancelHandshake] #
Show CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods showsPrec :: Int -> CancelHandshake -> ShowS # show :: CancelHandshake -> String # showList :: [CancelHandshake] -> ShowS #
NFData CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods rnf :: CancelHandshake -> () #
Eq CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods (==) :: CancelHandshake -> CancelHandshake -> Bool # (/=) :: CancelHandshake -> CancelHandshake -> Bool #
Hashable CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods hashWithSalt :: Int -> CancelHandshake -> Int # hash :: CancelHandshake -> Int #
type AWSResponse CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake type AWSResponse CancelHandshake = CancelHandshakeResponse
type Rep CancelHandshake Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake type Rep CancelHandshake = D1 ('MetaData "CancelHandshake" "Amazonka.Organizations.CancelHandshake" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "CancelHandshake'" 'PrefixI 'True) (S1 ('MetaSel ('Just "handshakeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCancelHandshake Source #

Arguments

:: Text	`$sel:handshakeId:CancelHandshake'`
-> CancelHandshake

Create a value of CancelHandshake with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:handshakeId:CancelHandshake', cancelHandshake_handshakeId - 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 lowercase letters or digits.

Request Lenses

cancelHandshake_handshakeId :: Lens' CancelHandshake Text Source #

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 lowercase letters or digits.

Destructuring the Response

data CancelHandshakeResponse Source #

See: newCancelHandshakeResponse smart constructor.

Constructors

CancelHandshakeResponse'
Fields handshake :: Maybe Handshake A structure that contains details about the handshake that you canceled. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CancelHandshakeResponse Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Associated Types type Rep CancelHandshakeResponse :: Type -> Type # Methods from :: CancelHandshakeResponse -> Rep CancelHandshakeResponse x # to :: Rep CancelHandshakeResponse x -> CancelHandshakeResponse #
Show CancelHandshakeResponse Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods showsPrec :: Int -> CancelHandshakeResponse -> ShowS # show :: CancelHandshakeResponse -> String # showList :: [CancelHandshakeResponse] -> ShowS #
NFData CancelHandshakeResponse Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods rnf :: CancelHandshakeResponse -> () #
Eq CancelHandshakeResponse Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake Methods (==) :: CancelHandshakeResponse -> CancelHandshakeResponse -> Bool # (/=) :: CancelHandshakeResponse -> CancelHandshakeResponse -> Bool #
type Rep CancelHandshakeResponse Source #
Instance details Defined in Amazonka.Organizations.CancelHandshake type Rep CancelHandshakeResponse = D1 ('MetaData "CancelHandshakeResponse" "Amazonka.Organizations.CancelHandshake" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "CancelHandshakeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "handshake") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Handshake)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCancelHandshakeResponse Source #

Arguments

:: Int	`$sel:httpStatus:CancelHandshakeResponse'`
-> CancelHandshakeResponse

Create a value of CancelHandshakeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:handshake:CancelHandshakeResponse', cancelHandshakeResponse_handshake - A structure that contains details about the handshake that you canceled.

$sel:httpStatus:CancelHandshakeResponse', cancelHandshakeResponse_httpStatus - The response's http status code.

Response Lenses

cancelHandshakeResponse_handshake :: Lens' CancelHandshakeResponse (Maybe Handshake) Source #

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

cancelHandshakeResponse_httpStatus :: Lens' CancelHandshakeResponse Int Source #

The response's http status code.