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

Class: Aws::Organizations::Types::Handshake

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

Overview

Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a master account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.

Note: Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in lists for only 30 days after entering that state After that they are deleted.

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The type of handshake, indicating what action occurs when the recipient accepts the handshake.

Returns:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1133

class Handshake < Struct.new(
  :id,
  :arn,
  :parties,
  :state,
  :requested_timestamp,
  :expiration_timestamp,
  :action,
  :resources)
  include Aws::Structure
end

#arnString

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

Returns:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1133

class Handshake < Struct.new(
  :id,
  :arn,
  :parties,
  :state,
  :requested_timestamp,
  :expiration_timestamp,
  :action,
  :resources)
  include Aws::Structure
end

#expiration_timestampTime

The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

Returns:

  • (Time)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1133

class Handshake < Struct.new(
  :id,
  :arn,
  :parties,
  :state,
  :requested_timestamp,
  :expiration_timestamp,
  :action,
  :resources)
  include Aws::Structure
end

#idString

The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.

Returns:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1133

class Handshake < Struct.new(
  :id,
  :arn,
  :parties,
  :state,
  :requested_timestamp,
  :expiration_timestamp,
  :action,
  :resources)
  include Aws::Structure
end

#partiesArray<Types::HandshakeParty>

Information about the two accounts that are participating in the handshake.

Returns:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1133

class Handshake < Struct.new(
  :id,
  :arn,
  :parties,
  :state,
  :requested_timestamp,
  :expiration_timestamp,
  :action,
  :resources)
  include Aws::Structure
end

#requested_timestampTime

The date and time that the handshake request was made.

Returns:

  • (Time)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1133

class Handshake < Struct.new(
  :id,
  :arn,
  :parties,
  :state,
  :requested_timestamp,
  :expiration_timestamp,
  :action,
  :resources)
  include Aws::Structure
end

#resourcesArray<Types::HandshakeResource>

Additional information that is needed to process the handshake.

Returns:



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1133

class Handshake < Struct.new(
  :id,
  :arn,
  :parties,
  :state,
  :requested_timestamp,
  :expiration_timestamp,
  :action,
  :resources)
  include Aws::Structure
end

#stateString

The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

  • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

  • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

  • CANCELED: This handshake is no longer active because it was canceled by the originating account.

  • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

  • DECLINED: This handshake is no longer active because it was declined by the recipient account.

  • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

Returns:

  • (String)


1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 1133

class Handshake < Struct.new(
  :id,
  :arn,
  :parties,
  :state,
  :requested_timestamp,
  :expiration_timestamp,
  :action,
  :resources)
  include Aws::Structure
end