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

Inherits:

Struct

• Object
• Struct
• Aws::Organizations::Types::Handshake

Includes:

Structure

Defined in:

lib/aws-sdk-organizations/types.rb

Overview

Contains details for a handshake. A handshake is the secure exchange of information between two Amazon Web Services accounts: a sender and a recipient.

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #action ⇒ String

  The type of handshake:.

• #arn ⇒ String

  Amazon Resource Name (ARN) for the handshake.

• #expiration_timestamp ⇒ Time

  Timestamp when the handshake expires.

• #id ⇒ String

  ID for the handshake.

• #parties ⇒ Array<Types::HandshakeParty>

  An array of ‘HandshakeParty` objects.

• #requested_timestamp ⇒ Time

  Timestamp when the handshake request was made.

• #resources ⇒ Array<Types::HandshakeResource>

  An array of ‘HandshakeResource` objects.

• #state ⇒ String

  Current state for the handshake.

Instance Attribute Details

#action ⇒ String

The type of handshake:

• INVITE: Handshake sent to a standalone account requesting that it to join the sender’s organization.

• ENABLE_ALL_FEATURES: Handshake sent to invited member accounts to enable all features for the organization.

• APPROVE_ALL_FEATURES: Handshake sent to the management account when all invited member accounts have approved to enable all features.

• TRANSFER_RESPONSIBILITY: Handshake sent to another organization’s management account requesting that it designate the sender with the specified responsibilities for recipient’s organization.

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2416

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

#arn ⇒ String

Amazon Resource Name (ARN) for the handshake.

For more information about ARNs in Organizations, see [ARN Formats Supported by Organizations] in the *Amazon Web Services Service Authorization Reference*.

[1]: docs.aws.amazon.com/service-authorization/latest/reference/list_awsorganizations.html#awsorganizations-resources-for-iam-policies

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2416

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

#expiration_timestamp ⇒ Time

Timestamp when the handshake expires.

Returns:

• (Time)

# File 'lib/aws-sdk-organizations/types.rb', line 2416

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

#id ⇒ String

ID for the handshake.

The [regex pattern] for handshake ID string requires “h-” followed by from 8 to 32 lowercase letters or digits.

[1]: wikipedia.org/wiki/regex

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2416

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

#parties ⇒ Array<Types::HandshakeParty>

An array of ‘HandshakeParty` objects. Contains details for participant in a handshake.

Returns:

• (Array<Types::HandshakeParty>)

# File 'lib/aws-sdk-organizations/types.rb', line 2416

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

#requested_timestamp ⇒ Time

Timestamp when the handshake request was made.

Returns:

• (Time)

# File 'lib/aws-sdk-organizations/types.rb', line 2416

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

#resources ⇒ Array<Types::HandshakeResource>

An array of ‘HandshakeResource` objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

Returns:

• (Array<Types::HandshakeResource>)

# File 'lib/aws-sdk-organizations/types.rb', line 2416

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

#state ⇒ String

Current state for the handshake.

• REQUESTED: Handshake awaiting a response from the recipient.

• OPEN: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.

• CANCELED: Handshake canceled by the sender.

• ACCEPTED: Handshake accepted by the recipient.

• DECLINED: Handshake declined by the recipient.

• EXPIRED: Handshake has expired.

Returns:

• (String)

# File 'lib/aws-sdk-organizations/types.rb', line 2416

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