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

Amazonka.Organizations.DeclineHandshake

Description

Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.

This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request.

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

Synopsis

Creating a Request

data DeclineHandshake Source #

See: newDeclineHandshake smart constructor.

Constructors

DeclineHandshake' 

Fields

  • handshakeId :: Text

    The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.

    The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

Instances

Instances details
Eq DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Read DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Show DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Generic DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Associated Types

type Rep DeclineHandshake :: Type -> Type #

NFData DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Methods

rnf :: DeclineHandshake -> () #

Hashable DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

ToJSON DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

AWSRequest DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Associated Types

type AWSResponse DeclineHandshake #

ToHeaders DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

ToPath DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

ToQuery DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

type Rep DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

type Rep DeclineHandshake = D1 ('MetaData "DeclineHandshake" "Amazonka.Organizations.DeclineHandshake" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DeclineHandshake'" 'PrefixI 'True) (S1 ('MetaSel ('Just "handshakeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DeclineHandshake Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

newDeclineHandshake Source #

Create a value of DeclineHandshake 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:DeclineHandshake', declineHandshake_handshakeId - The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

Request Lenses

declineHandshake_handshakeId :: Lens' DeclineHandshake Text Source #

The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

Destructuring the Response

data DeclineHandshakeResponse Source #

See: newDeclineHandshakeResponse smart constructor.

Constructors

DeclineHandshakeResponse' 

Fields

  • handshake :: Maybe Handshake

    A structure that contains details about the declined handshake. The state is updated to show the value DECLINED.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DeclineHandshakeResponse Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Show DeclineHandshakeResponse Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Generic DeclineHandshakeResponse Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

Associated Types

type Rep DeclineHandshakeResponse :: Type -> Type #

NFData DeclineHandshakeResponse Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

type Rep DeclineHandshakeResponse Source # 
Instance details

Defined in Amazonka.Organizations.DeclineHandshake

type Rep DeclineHandshakeResponse = D1 ('MetaData "DeclineHandshakeResponse" "Amazonka.Organizations.DeclineHandshake" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DeclineHandshakeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "handshake") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Handshake)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeclineHandshakeResponse Source #

Create a value of DeclineHandshakeResponse 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:DeclineHandshakeResponse', declineHandshakeResponse_handshake - A structure that contains details about the declined handshake. The state is updated to show the value DECLINED.

$sel:httpStatus:DeclineHandshakeResponse', declineHandshakeResponse_httpStatus - The response's http status code.

Response Lenses

declineHandshakeResponse_handshake :: Lens' DeclineHandshakeResponse (Maybe Handshake) Source #

A structure that contains details about the declined handshake. The state is updated to show the value DECLINED.