Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HandshakeResource

Contains additional data that is needed to process a handshake.

Hierarchy

  • HandshakeResource

Index

Properties

Properties

Optional Resources

Resources: HandshakeResource[]

When needed, contains an additional array of HandshakeResource objects.

Optional Type

Type: HandshakeResourceType | string

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.

Optional Value

Value: undefined | 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.