Class Handshake

java.lang.Object
software.amazon.awssdk.services.organizations.model.Handshake
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Handshake.Builder,Handshake>
@Generated("software.amazon.awssdk:codegen") public final class Handshake extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Handshake.Builder,Handshake>

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:

  • Method Details

    • id

      public final String id()

      ID for the handshake.

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

      Returns:
      ID for the handshake.

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

    • arn

      public final String arn()

      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.

      Returns:
      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.

    • hasParties

      public final boolean hasParties()
      For responses, this returns true if the service returned a value for the Parties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • parties

      public final List<HandshakeParty> parties()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParties() method.

      Returns:
      An array of HandshakeParty objects. Contains details for participant in a handshake.

    • state

      public final HandshakeState state()

      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.

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

      See Also:

    • stateAsString

      public final String stateAsString()

      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.

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

      See Also:

    • requestedTimestamp

      public final Instant requestedTimestamp()

      Timestamp when the handshake request was made.

      Returns:
      Timestamp when the handshake request was made.

    • expirationTimestamp

      public final Instant expirationTimestamp()

      Timestamp when the handshake expires.

      Returns:
      Timestamp when the handshake expires.

    • action

      public final ActionType action()

      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.

      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:

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

      See Also:

    • actionAsString

      public final String actionAsString()

      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.

      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:

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

      See Also:

    • hasResources

      public final boolean hasResources()
      For responses, this returns true if the service returned a value for the Resources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resources

      public final List<HandshakeResource> resources()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResources() method.

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

    • 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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.