AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Inheritance Hierarchy

System.Object
  Amazon.Organizations.Model.Handshake

Namespace: Amazon.Organizations.Model
Assembly: AWSSDK.Organizations.dll
Version: 3.x.y.z

Syntax

C#
public class Handshake

The Handshake type exposes the following members

Constructors

NameDescription
Public Method Handshake()

Properties

NameTypeDescription
Public Property Action Amazon.Organizations.ActionType

Gets and sets the property Action.

The type of handshake, indicating what action occurs when the recipient accepts the handshake.

Public Property Arn System.String

Gets and sets the property 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.

Public Property ExpirationTimestamp System.DateTime

Gets and sets the property 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 Property Id System.String

Gets and sets the property 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.

Public Property Parties System.Collections.Generic.List<Amazon.Organizations.Model.HandshakeParty>

Gets and sets the property Parties.

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

Public Property RequestedTimestamp System.DateTime

Gets and sets the property RequestedTimestamp.

The date and time that the handshake request was made.

Public Property Resources System.Collections.Generic.List<Amazon.Organizations.Model.HandshakeResource>

Gets and sets the property Resources.

Additional information that is needed to process the handshake.

Public Property State Amazon.Organizations.HandshakeState

Gets and sets the property 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).

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms