StructuredPojo, ToCopyableBuilder<Handshake.Builder,Handshake>@Generated("software.amazon.awssdk:codegen") public class Handshake extends Object implements StructuredPojo, 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.
| Modifier and Type | Class | Description |
|---|---|---|
static interface |
Handshake.Builder |
| Modifier and Type | Method | Description |
|---|---|---|
String |
action() |
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) |
|
Date |
expirationTimestamp() |
The date and time that the handshake expires.
|
int |
hashCode() |
|
String |
id() |
The unique identifier (ID) of a handshake.
|
void |
marshall(ProtocolMarshaller protocolMarshaller) |
Marshalls this structured data using the given
ProtocolMarshaller. |
List<HandshakeParty> |
parties() |
Information about the two accounts that are participating in the handshake.
|
Date |
requestedTimestamp() |
The date and time that the handshake request was made.
|
List<HandshakeResource> |
resources() |
Additional information that is needed to process the handshake.
|
static Class<? extends Handshake.Builder> |
serializableBuilderClass() |
|
String |
state() |
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() |
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.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
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.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
public List<HandshakeParty> parties()
Information about the two accounts that are participating in the handshake.
public String 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).
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).
HandshakeStatepublic Date requestedTimestamp()
The date and time that the handshake request was made.
public Date 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.
public String action()
The type of handshake, indicating what action occurs when the recipient accepts the handshake.
ActionTypepublic List<HandshakeResource> resources()
Additional information that is needed to process the handshake.
public Handshake.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<Handshake.Builder,Handshake>public static Handshake.Builder builder()
public static Class<? extends Handshake.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.