You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Organizations::Types::HandshakeResource

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Contains additional data that is needed to process a handshake.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#resources ⇒ Array<Types::HandshakeResource>

When needed, contains an additional array of HandshakeResource objects.

Returns:

#type ⇒ String

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.

    Possible values:

    • ACCOUNT
    • ORGANIZATION
    • ORGANIZATION_FEATURE_SET
    • EMAIL
    • MASTER_EMAIL
    • MASTER_NAME
    • NOTES
    • PARENT_HANDSHAKE

Returns:

  • (String) —

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

#value ⇒ String

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.

Returns:

  • (String) —

    The information that is passed to the other party in the handshake.