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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb

Overview

Contains additional data that is needed to process a handshake.

Instance Attribute Summary collapse

Instance Attribute Details

#resourcesArray<Types::HandshakeResource>

When needed, contains an additional array of HandshakeResource objects.

Returns:



1336
1337
1338
1339
1340
1341
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1336

class HandshakeResource < Struct.new(
  :value,
  :type,
  :resources)
  include Aws::Structure
end

#typeString

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 master account. Included as information about an organization.

  • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

  • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

Returns:

  • (String)


1336
1337
1338
1339
1340
1341
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1336

class HandshakeResource < Struct.new(
  :value,
  :type,
  :resources)
  include Aws::Structure
end

#valueString

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)


1336
1337
1338
1339
1340
1341
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1336

class HandshakeResource < Struct.new(
  :value,
  :type,
  :resources)
  include Aws::Structure
end