Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Organizations.Types.HandshakeResource

Description

Documentation

data HandshakeResource Source #

Contains additional data that is needed to process a handshake.

See: newHandshakeResource smart constructor.

Constructors

HandshakeResource'

Fields

value :: Maybe (Sensitive Text)
The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.
resources :: Maybe [HandshakeResource]
When needed, contains an additional array of HandshakeResource objects.
type' :: Maybe HandshakeResourceType
The type of information being passed, specifying how the value is to be interpreted by the other party:
- ACCOUNT - Specifies an AWS account ID number.
- ORGANIZATION - Specifies an organization ID number.
- EMAIL - Specifies the email address that is associated with the account that receives the handshake.
- OWNER_EMAIL - Specifies the email address associated with the management account. Included as information about an organization.
- OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.
- NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

Instances

Instances details

Eq HandshakeResource Source #
Instance details Defined in Amazonka.Organizations.Types.HandshakeResource Methods (==) :: HandshakeResource -> HandshakeResource -> Bool # (/=) :: HandshakeResource -> HandshakeResource -> Bool #
Show HandshakeResource Source #
Instance details Defined in Amazonka.Organizations.Types.HandshakeResource Methods showsPrec :: Int -> HandshakeResource -> ShowS # show :: HandshakeResource -> String # showList :: [HandshakeResource] -> ShowS #
Generic HandshakeResource Source #
Instance details Defined in Amazonka.Organizations.Types.HandshakeResource Associated Types type Rep HandshakeResource :: Type -> Type # Methods from :: HandshakeResource -> Rep HandshakeResource x # to :: Rep HandshakeResource x -> HandshakeResource #
NFData HandshakeResource Source #
Instance details Defined in Amazonka.Organizations.Types.HandshakeResource Methods rnf :: HandshakeResource -> () #
Hashable HandshakeResource Source #
Instance details Defined in Amazonka.Organizations.Types.HandshakeResource Methods hashWithSalt :: Int -> HandshakeResource -> Int # hash :: HandshakeResource -> Int #
FromJSON HandshakeResource Source #
Instance details Defined in Amazonka.Organizations.Types.HandshakeResource Methods parseJSON :: Value -> Parser HandshakeResource # parseJSONList :: Value -> Parser [HandshakeResource] #
type Rep HandshakeResource Source #
Instance details Defined in Amazonka.Organizations.Types.HandshakeResource type Rep HandshakeResource = D1 ('MetaData "HandshakeResource" "Amazonka.Organizations.Types.HandshakeResource" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "HandshakeResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HandshakeResource])) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HandshakeResourceType)))))

newHandshakeResource :: HandshakeResource Source #

Create a value of HandshakeResource 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:value:HandshakeResource', handshakeResource_value - The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

$sel:resources:HandshakeResource', handshakeResource_resources - When needed, contains an additional array of HandshakeResource objects.

$sel:type':HandshakeResource', handshakeResource_type - The type of information being passed, specifying how the value is to be interpreted by the other party:

ACCOUNT - Specifies an AWS account ID number.
ORGANIZATION - Specifies an organization ID number.
EMAIL - Specifies the email address that is associated with the account that receives the handshake.
OWNER_EMAIL - Specifies the email address associated with the management account. Included as information about an organization.
OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.
NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

handshakeResource_value :: Lens' HandshakeResource (Maybe Text) Source #

The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

handshakeResource_resources :: Lens' HandshakeResource (Maybe [HandshakeResource]) Source #

When needed, contains an additional array of HandshakeResource objects.

handshakeResource_type :: Lens' HandshakeResource (Maybe HandshakeResourceType) Source #

The type of information being passed, specifying how the value is to be interpreted by the other party:

ACCOUNT - Specifies an AWS account ID number.
ORGANIZATION - Specifies an organization ID number.
EMAIL - Specifies the email address that is associated with the account that receives the handshake.
OWNER_EMAIL - Specifies the email address associated with the management account. Included as information about an organization.
OWNER_NAME - Specifies the name associated with the management account. Included as information about an organization.
NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.