Handshake (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.organizations.model.Handshake

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Handshake.Builder,Handshake>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Handshake
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Handshake.Builder,Handshake>
```
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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Handshake.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Handshake.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActionType`	`action()` The type of handshake, indicating what action occurs when the recipient accepts the handshake.
`String`	`actionAsString()` The type of handshake, indicating what action occurs when the recipient accepts the handshake.
`String`	`arn()` The Amazon Resource Name (ARN) of a handshake.
`static Handshake.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`Instant`	`expirationTimestamp()` The date and time that the handshake expires.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The unique identifier (ID) of a handshake.
`List<HandshakeParty>`	`parties()` Information about the two accounts that are participating in the handshake.
`Instant`	`requestedTimestamp()` The date and time that the handshake request was made.
`List<HandshakeResource>`	`resources()` Additional information that is needed to process the handshake.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Handshake.Builder>`	`serializableBuilderClass()`
`HandshakeState`	`state()` The current state of the handshake.
`String`	`stateAsString()` The current state of the handshake.
`Handshake.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - id
```
public String id()
```
    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:
    
    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.
  - arn
```
public String arn()
```
    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:
    
    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.
  - parties
```
public List<HandshakeParty> parties()
```
    Information about the two accounts that are participating in the handshake.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Information about the two accounts that are participating in the handshake.
  - state
```
public HandshakeState state()
```
    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).
    If the service returns an enum value that is not available in the current SDK version, state will return HandshakeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    Returns:
    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).
    See Also:
    
    HandshakeState
  - stateAsString
```
public String stateAsString()
```
    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).
    If the service returns an enum value that is not available in the current SDK version, state will return HandshakeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    Returns:
    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).
    See Also:
    
    HandshakeState
  - requestedTimestamp
```
public Instant requestedTimestamp()
```
    The date and time that the handshake request was made.
    
    Returns:
    
    The date and time that the handshake request was made.
  - expirationTimestamp
```
public Instant expirationTimestamp()
```
    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:
    
    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.
  - action
```
public ActionType action()
```
    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 master 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 master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master 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 master account and signals the master that it can finalize the process to enable all features.
    If the service returns an enum value that is not available in the current SDK version, action will return ActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    Returns:
    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 master 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 master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master 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 master account and signals the master that it can finalize the process to enable all features.
    See Also:
    
    ActionType
  - actionAsString
```
public String actionAsString()
```
    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 master 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 master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master 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 master account and signals the master that it can finalize the process to enable all features.
    If the service returns an enum value that is not available in the current SDK version, action will return ActionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().
    Returns:
    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 master 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 master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master 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 master account and signals the master that it can finalize the process to enable all features.
    See Also:
    
    ActionType
  - resources
```
public List<HandshakeResource> resources()
```
    Additional information that is needed to process the handshake.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Additional information that is needed to process the handshake.
  - toBuilder
```
public Handshake.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Handshake.Builder,Handshake>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Handshake.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Handshake.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Handshake

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

arn

parties

state

stateAsString

requestedTimestamp

expirationTimestamp

action

actionAsString

resources

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields