/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the organizations-2016-11-28.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.Organizations.Model
{
///
/// 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
, DECLINED
,
/// or EXPIRED
show up in lists for only 30 days after entering that state
/// After that they are deleted.
///
///
public partial class Handshake
{
private ActionType _action;
private string _arn;
private DateTime? _expirationTimestamp;
private string _id;
private List _parties = new List();
private DateTime? _requestedTimestamp;
private List _resources = new List();
private HandshakeState _state;
///
/// Gets and sets the property 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 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.
///
///
///
public ActionType Action
{
get { return this._action; }
set { this._action = value; }
}
// Check to see if Action property is set
internal bool IsSetAction()
{
return this._action != null;
}
///
/// 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 Amazon Web Services Service Authorization
/// Reference.
///
///
public string Arn
{
get { return this._arn; }
set { this._arn = value; }
}
// Check to see if Arn property is set
internal bool IsSetArn()
{
return this._arn != null;
}
///
/// 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 DateTime ExpirationTimestamp
{
get { return this._expirationTimestamp.GetValueOrDefault(); }
set { this._expirationTimestamp = value; }
}
// Check to see if ExpirationTimestamp property is set
internal bool IsSetExpirationTimestamp()
{
return this._expirationTimestamp.HasValue;
}
///
/// 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 lowercase letters or digits.
///
///
[AWSProperty(Max=34)]
public string Id
{
get { return this._id; }
set { this._id = value; }
}
// Check to see if Id property is set
internal bool IsSetId()
{
return this._id != null;
}
///
/// Gets and sets the property Parties.
///
/// Information about the two accounts that are participating in the handshake.
///
///
public List Parties
{
get { return this._parties; }
set { this._parties = value; }
}
// Check to see if Parties property is set
internal bool IsSetParties()
{
return this._parties != null && this._parties.Count > 0;
}
///
/// Gets and sets the property RequestedTimestamp.
///
/// The date and time that the handshake request was made.
///
///
public DateTime RequestedTimestamp
{
get { return this._requestedTimestamp.GetValueOrDefault(); }
set { this._requestedTimestamp = value; }
}
// Check to see if RequestedTimestamp property is set
internal bool IsSetRequestedTimestamp()
{
return this._requestedTimestamp.HasValue;
}
///
/// Gets and sets the property Resources.
///
/// Additional information that is needed to process the handshake.
///
///
public List Resources
{
get { return this._resources; }
set { this._resources = value; }
}
// Check to see if Resources property is set
internal bool IsSetResources()
{
return this._resources != null && this._resources.Count > 0;
}
///
/// 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).
///
///
///
public HandshakeState State
{
get { return this._state; }
set { this._state = value; }
}
// Check to see if State property is set
internal bool IsSetState()
{
return this._state != null;
}
}
}