AWS SDK for C++  1.9.129
AWS SDK for C++
Public Member Functions | List of all members
Aws::Organizations::Model::Handshake Class Reference

#include <Handshake.h>

Public Member Functions

 Handshake ()
 
 Handshake (Aws::Utils::Json::JsonView jsonValue)
 
Handshakeoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
HandshakeWithId (const Aws::String &value)
 
HandshakeWithId (Aws::String &&value)
 
HandshakeWithId (const char *value)
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
HandshakeWithArn (const Aws::String &value)
 
HandshakeWithArn (Aws::String &&value)
 
HandshakeWithArn (const char *value)
 
const Aws::Vector< HandshakeParty > & GetParties () const
 
bool PartiesHasBeenSet () const
 
void SetParties (const Aws::Vector< HandshakeParty > &value)
 
void SetParties (Aws::Vector< HandshakeParty > &&value)
 
HandshakeWithParties (const Aws::Vector< HandshakeParty > &value)
 
HandshakeWithParties (Aws::Vector< HandshakeParty > &&value)
 
HandshakeAddParties (const HandshakeParty &value)
 
HandshakeAddParties (HandshakeParty &&value)
 
const HandshakeStateGetState () const
 
bool StateHasBeenSet () const
 
void SetState (const HandshakeState &value)
 
void SetState (HandshakeState &&value)
 
HandshakeWithState (const HandshakeState &value)
 
HandshakeWithState (HandshakeState &&value)
 
const Aws::Utils::DateTimeGetRequestedTimestamp () const
 
bool RequestedTimestampHasBeenSet () const
 
void SetRequestedTimestamp (const Aws::Utils::DateTime &value)
 
void SetRequestedTimestamp (Aws::Utils::DateTime &&value)
 
HandshakeWithRequestedTimestamp (const Aws::Utils::DateTime &value)
 
HandshakeWithRequestedTimestamp (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetExpirationTimestamp () const
 
bool ExpirationTimestampHasBeenSet () const
 
void SetExpirationTimestamp (const Aws::Utils::DateTime &value)
 
void SetExpirationTimestamp (Aws::Utils::DateTime &&value)
 
HandshakeWithExpirationTimestamp (const Aws::Utils::DateTime &value)
 
HandshakeWithExpirationTimestamp (Aws::Utils::DateTime &&value)
 
const ActionTypeGetAction () const
 
bool ActionHasBeenSet () const
 
void SetAction (const ActionType &value)
 
void SetAction (ActionType &&value)
 
HandshakeWithAction (const ActionType &value)
 
HandshakeWithAction (ActionType &&value)
 
const Aws::Vector< HandshakeResource > & GetResources () const
 
bool ResourcesHasBeenSet () const
 
void SetResources (const Aws::Vector< HandshakeResource > &value)
 
void SetResources (Aws::Vector< HandshakeResource > &&value)
 
HandshakeWithResources (const Aws::Vector< HandshakeResource > &value)
 
HandshakeWithResources (Aws::Vector< HandshakeResource > &&value)
 
HandshakeAddResources (const HandshakeResource &value)
 
HandshakeAddResources (HandshakeResource &&value)
 

Detailed Description

Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a management 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.

See Also:

AWS API Reference

Definition at line 44 of file Handshake.h.

Constructor & Destructor Documentation

◆ Handshake() [1/2]

Aws::Organizations::Model::Handshake::Handshake ( )

◆ Handshake() [2/2]

Aws::Organizations::Model::Handshake::Handshake ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActionHasBeenSet()

bool Aws::Organizations::Model::Handshake::ActionHasBeenSet ( ) const
inline

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts.

  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred.

  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.

Definition at line 469 of file Handshake.h.

◆ AddParties() [1/2]

Handshake& Aws::Organizations::Model::Handshake::AddParties ( const HandshakeParty value)
inline

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

Definition at line 231 of file Handshake.h.

◆ AddParties() [2/2]

Handshake& Aws::Organizations::Model::Handshake::AddParties ( HandshakeParty &&  value)
inline

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

Definition at line 237 of file Handshake.h.

◆ AddResources() [1/2]

Handshake& Aws::Organizations::Model::Handshake::AddResources ( const HandshakeResource value)
inline

Additional information that is needed to process the handshake.

Definition at line 577 of file Handshake.h.

◆ AddResources() [2/2]

Handshake& Aws::Organizations::Model::Handshake::AddResources ( HandshakeResource &&  value)
inline

Additional information that is needed to process the handshake.

Definition at line 582 of file Handshake.h.

◆ ArnHasBeenSet()

bool Aws::Organizations::Model::Handshake::ArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 134 of file Handshake.h.

◆ ExpirationTimestampHasBeenSet()

bool Aws::Organizations::Model::Handshake::ExpirationTimestampHasBeenSet ( ) const
inline

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.

Definition at line 404 of file Handshake.h.

◆ GetAction()

const ActionType& Aws::Organizations::Model::Handshake::GetAction ( ) const
inline

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts.

  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred.

  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.

Definition at line 451 of file Handshake.h.

◆ GetArn()

const Aws::String& Aws::Organizations::Model::Handshake::GetArn ( ) const
inline

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 125 of file Handshake.h.

◆ GetExpirationTimestamp()

const Aws::Utils::DateTime& Aws::Organizations::Model::Handshake::GetExpirationTimestamp ( ) const
inline

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.

Definition at line 397 of file Handshake.h.

◆ GetId()

const Aws::String& Aws::Organizations::Model::Handshake::GetId ( ) const
inline

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 lowercase letters or digits.

Definition at line 59 of file Handshake.h.

◆ GetParties()

const Aws::Vector<HandshakeParty>& Aws::Organizations::Model::Handshake::GetParties ( ) const
inline

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

Definition at line 195 of file Handshake.h.

◆ GetRequestedTimestamp()

const Aws::Utils::DateTime& Aws::Organizations::Model::Handshake::GetRequestedTimestamp ( ) const
inline

The date and time that the handshake request was made.

Definition at line 364 of file Handshake.h.

◆ GetResources()

const Aws::Vector<HandshakeResource>& Aws::Organizations::Model::Handshake::GetResources ( ) const
inline

Additional information that is needed to process the handshake.

Definition at line 547 of file Handshake.h.

◆ GetState()

const HandshakeState& Aws::Organizations::Model::Handshake::GetState ( ) const
inline

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).

Definition at line 258 of file Handshake.h.

◆ IdHasBeenSet()

bool Aws::Organizations::Model::Handshake::IdHasBeenSet ( ) const
inline

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 lowercase letters or digits.

Definition at line 67 of file Handshake.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Organizations::Model::Handshake::Jsonize ( ) const

◆ operator=()

Handshake& Aws::Organizations::Model::Handshake::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PartiesHasBeenSet()

bool Aws::Organizations::Model::Handshake::PartiesHasBeenSet ( ) const
inline

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

Definition at line 201 of file Handshake.h.

◆ RequestedTimestampHasBeenSet()

bool Aws::Organizations::Model::Handshake::RequestedTimestampHasBeenSet ( ) const
inline

The date and time that the handshake request was made.

Definition at line 369 of file Handshake.h.

◆ ResourcesHasBeenSet()

bool Aws::Organizations::Model::Handshake::ResourcesHasBeenSet ( ) const
inline

Additional information that is needed to process the handshake.

Definition at line 552 of file Handshake.h.

◆ SetAction() [1/2]

void Aws::Organizations::Model::Handshake::SetAction ( ActionType &&  value)
inline

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts.

  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred.

  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.

Definition at line 505 of file Handshake.h.

◆ SetAction() [2/2]

void Aws::Organizations::Model::Handshake::SetAction ( const ActionType value)
inline

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts.

  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred.

  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.

Definition at line 487 of file Handshake.h.

◆ SetArn() [1/3]

void Aws::Organizations::Model::Handshake::SetArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 152 of file Handshake.h.

◆ SetArn() [2/3]

void Aws::Organizations::Model::Handshake::SetArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 143 of file Handshake.h.

◆ SetArn() [3/3]

void Aws::Organizations::Model::Handshake::SetArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 161 of file Handshake.h.

◆ SetExpirationTimestamp() [1/2]

void Aws::Organizations::Model::Handshake::SetExpirationTimestamp ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 418 of file Handshake.h.

◆ SetExpirationTimestamp() [2/2]

void Aws::Organizations::Model::Handshake::SetExpirationTimestamp ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 411 of file Handshake.h.

◆ SetId() [1/3]

void Aws::Organizations::Model::Handshake::SetId ( Aws::String &&  value)
inline

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 lowercase letters or digits.

Definition at line 83 of file Handshake.h.

◆ SetId() [2/3]

void Aws::Organizations::Model::Handshake::SetId ( const Aws::String value)
inline

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 lowercase letters or digits.

Definition at line 75 of file Handshake.h.

◆ SetId() [3/3]

void Aws::Organizations::Model::Handshake::SetId ( const char *  value)
inline

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 lowercase letters or digits.

Definition at line 91 of file Handshake.h.

◆ SetParties() [1/2]

void Aws::Organizations::Model::Handshake::SetParties ( Aws::Vector< HandshakeParty > &&  value)
inline

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

Definition at line 213 of file Handshake.h.

◆ SetParties() [2/2]

void Aws::Organizations::Model::Handshake::SetParties ( const Aws::Vector< HandshakeParty > &  value)
inline

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

Definition at line 207 of file Handshake.h.

◆ SetRequestedTimestamp() [1/2]

void Aws::Organizations::Model::Handshake::SetRequestedTimestamp ( Aws::Utils::DateTime &&  value)
inline

The date and time that the handshake request was made.

Definition at line 379 of file Handshake.h.

◆ SetRequestedTimestamp() [2/2]

void Aws::Organizations::Model::Handshake::SetRequestedTimestamp ( const Aws::Utils::DateTime value)
inline

The date and time that the handshake request was made.

Definition at line 374 of file Handshake.h.

◆ SetResources() [1/2]

void Aws::Organizations::Model::Handshake::SetResources ( Aws::Vector< HandshakeResource > &&  value)
inline

Additional information that is needed to process the handshake.

Definition at line 562 of file Handshake.h.

◆ SetResources() [2/2]

void Aws::Organizations::Model::Handshake::SetResources ( const Aws::Vector< HandshakeResource > &  value)
inline

Additional information that is needed to process the handshake.

Definition at line 557 of file Handshake.h.

◆ SetState() [1/2]

void Aws::Organizations::Model::Handshake::SetState ( const HandshakeState value)
inline

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).

Definition at line 298 of file Handshake.h.

◆ SetState() [2/2]

void Aws::Organizations::Model::Handshake::SetState ( HandshakeState &&  value)
inline

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).

Definition at line 318 of file Handshake.h.

◆ StateHasBeenSet()

bool Aws::Organizations::Model::Handshake::StateHasBeenSet ( ) const
inline

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).

Definition at line 278 of file Handshake.h.

◆ WithAction() [1/2]

Handshake& Aws::Organizations::Model::Handshake::WithAction ( ActionType &&  value)
inline

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts.

  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred.

  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.

Definition at line 541 of file Handshake.h.

◆ WithAction() [2/2]

Handshake& Aws::Organizations::Model::Handshake::WithAction ( const ActionType value)
inline

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the management account to only non-member accounts.

  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management account and approval is inferred.

  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the management account and signals the master that it can finalize the process to enable all features.

Definition at line 523 of file Handshake.h.

◆ WithArn() [1/3]

Handshake& Aws::Organizations::Model::Handshake::WithArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 179 of file Handshake.h.

◆ WithArn() [2/3]

Handshake& Aws::Organizations::Model::Handshake::WithArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 170 of file Handshake.h.

◆ WithArn() [3/3]

Handshake& Aws::Organizations::Model::Handshake::WithArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Service Authorization Reference.

Definition at line 188 of file Handshake.h.

◆ WithExpirationTimestamp() [1/2]

Handshake& Aws::Organizations::Model::Handshake::WithExpirationTimestamp ( Aws::Utils::DateTime &&  value)
inline

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.

Definition at line 432 of file Handshake.h.

◆ WithExpirationTimestamp() [2/2]

Handshake& Aws::Organizations::Model::Handshake::WithExpirationTimestamp ( const Aws::Utils::DateTime value)
inline

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.

Definition at line 425 of file Handshake.h.

◆ WithId() [1/3]

Handshake& Aws::Organizations::Model::Handshake::WithId ( Aws::String &&  value)
inline

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 lowercase letters or digits.

Definition at line 107 of file Handshake.h.

◆ WithId() [2/3]

Handshake& Aws::Organizations::Model::Handshake::WithId ( const Aws::String value)
inline

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 lowercase letters or digits.

Definition at line 99 of file Handshake.h.

◆ WithId() [3/3]

Handshake& Aws::Organizations::Model::Handshake::WithId ( const char *  value)
inline

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 lowercase letters or digits.

Definition at line 115 of file Handshake.h.

◆ WithParties() [1/2]

Handshake& Aws::Organizations::Model::Handshake::WithParties ( Aws::Vector< HandshakeParty > &&  value)
inline

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

Definition at line 225 of file Handshake.h.

◆ WithParties() [2/2]

Handshake& Aws::Organizations::Model::Handshake::WithParties ( const Aws::Vector< HandshakeParty > &  value)
inline

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

Definition at line 219 of file Handshake.h.

◆ WithRequestedTimestamp() [1/2]

Handshake& Aws::Organizations::Model::Handshake::WithRequestedTimestamp ( Aws::Utils::DateTime &&  value)
inline

The date and time that the handshake request was made.

Definition at line 389 of file Handshake.h.

◆ WithRequestedTimestamp() [2/2]

Handshake& Aws::Organizations::Model::Handshake::WithRequestedTimestamp ( const Aws::Utils::DateTime value)
inline

The date and time that the handshake request was made.

Definition at line 384 of file Handshake.h.

◆ WithResources() [1/2]

Handshake& Aws::Organizations::Model::Handshake::WithResources ( Aws::Vector< HandshakeResource > &&  value)
inline

Additional information that is needed to process the handshake.

Definition at line 572 of file Handshake.h.

◆ WithResources() [2/2]

Handshake& Aws::Organizations::Model::Handshake::WithResources ( const Aws::Vector< HandshakeResource > &  value)
inline

Additional information that is needed to process the handshake.

Definition at line 567 of file Handshake.h.

◆ WithState() [1/2]

Handshake& Aws::Organizations::Model::Handshake::WithState ( const HandshakeState value)
inline

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).

Definition at line 338 of file Handshake.h.

◆ WithState() [2/2]

Handshake& Aws::Organizations::Model::Handshake::WithState ( HandshakeState &&  value)
inline

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).

Definition at line 358 of file Handshake.h.


The documentation for this class was generated from the following file: