Amazonka.Organizations.Types.HandshakeResource

Documentation

data HandshakeResource

Contains additional data that is needed to process a handshake.

See: newHandshakeResource smart constructor.

Constructors

HandshakeResource'

Fields

• 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 Amazon Web Services 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.
• 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.

Instances

FromJSON HandshakeResource

Defined in Amazonka.Organizations.Types.HandshakeResource

Methods

parseJSON :: Value -> Parser HandshakeResource

parseJSONList :: Value -> Parser [HandshakeResource]

Generic HandshakeResource

Defined in Amazonka.Organizations.Types.HandshakeResource

Associated Types

type Rep HandshakeResource :: Type -> Type

Methods

from :: HandshakeResource -> Rep HandshakeResource x

to :: Rep HandshakeResource x -> HandshakeResource

Show HandshakeResource

Defined in Amazonka.Organizations.Types.HandshakeResource

Methods

showsPrec :: Int -> HandshakeResource -> ShowS

show :: HandshakeResource -> String

showList :: [HandshakeResource] -> ShowS

NFData HandshakeResource

Defined in Amazonka.Organizations.Types.HandshakeResource

Methods

rnf :: HandshakeResource -> ()

Eq HandshakeResource

Defined in Amazonka.Organizations.Types.HandshakeResource

Methods

(==) :: HandshakeResource -> HandshakeResource -> Bool

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

Hashable HandshakeResource

Defined in Amazonka.Organizations.Types.HandshakeResource

Methods

hashWithSalt :: Int -> HandshakeResource -> Int

hash :: HandshakeResource -> Int

type Rep HandshakeResource

Defined in Amazonka.Organizations.Types.HandshakeResource

type Rep HandshakeResource = D1 ('MetaData "HandshakeResource" "Amazonka.Organizations.Types.HandshakeResource" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "HandshakeResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resources") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [HandshakeResource])) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HandshakeResourceType)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))))))

newHandshakeResource :: HandshakeResource

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: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 Amazon Web Services 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.

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

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

When needed, contains an additional array of HandshakeResource objects.

handshakeResource_type :: Lens' HandshakeResource (Maybe HandshakeResourceType)

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

• ACCOUNT - Specifies an Amazon Web Services 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)

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.