amazonka-managedblockchain-2.0: Amazon Managed Blockchain SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ManagedBlockChain.Types.Invitation

Description

 
Synopsis

Documentation

data Invitation Source #

An invitation to an Amazon Web Services account to create a member and join the network.

Applies only to Hyperledger Fabric.

See: newInvitation smart constructor.

Constructors

Invitation' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

  • creationDate :: Maybe ISO8601

    The date and time that the invitation was created.

  • expirationDate :: Maybe ISO8601

    The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId.

  • invitationId :: Maybe Text

    The unique identifier for the invitation.

  • networkSummary :: Maybe NetworkSummary
     
  • status :: Maybe InvitationStatus

    The status of the invitation:

    • PENDING - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.
    • ACCEPTING - The invitee has begun creating a member, and creation hasn't yet completed.
    • ACCEPTED - The invitee created a member and joined the network using the InvitationID.
    • REJECTED - The invitee rejected the invitation.
    • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate.

Instances

Instances details
FromJSON Invitation Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.Types.Invitation

Generic Invitation Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.Types.Invitation

Associated Types

type Rep Invitation :: Type -> Type #

Read Invitation Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.Types.Invitation

Show Invitation Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.Types.Invitation

NFData Invitation Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.Types.Invitation

Methods

rnf :: Invitation -> () #

Eq Invitation Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.Types.Invitation

Hashable Invitation Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.Types.Invitation

type Rep Invitation Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.Types.Invitation

type Rep Invitation = D1 ('MetaData "Invitation" "Amazonka.ManagedBlockChain.Types.Invitation" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "Invitation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :*: S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))) :*: (S1 ('MetaSel ('Just "invitationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "networkSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NetworkSummary)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InvitationStatus))))))

newInvitation :: Invitation Source #

Create a value of Invitation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

Invitation, invitation_arn - The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Invitation, invitation_creationDate - The date and time that the invitation was created.

$sel:expirationDate:Invitation', invitation_expirationDate - The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId.

$sel:invitationId:Invitation', invitation_invitationId - The unique identifier for the invitation.

$sel:networkSummary:Invitation', invitation_networkSummary - Undocumented member.

Invitation, invitation_status - The status of the invitation:

  • PENDING - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.
  • ACCEPTING - The invitee has begun creating a member, and creation hasn't yet completed.
  • ACCEPTED - The invitee created a member and joined the network using the InvitationID.
  • REJECTED - The invitee rejected the invitation.
  • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate.

invitation_arn :: Lens' Invitation (Maybe Text) Source #

The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

invitation_creationDate :: Lens' Invitation (Maybe UTCTime) Source #

The date and time that the invitation was created.

invitation_expirationDate :: Lens' Invitation (Maybe UTCTime) Source #

The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId.

invitation_invitationId :: Lens' Invitation (Maybe Text) Source #

The unique identifier for the invitation.

invitation_status :: Lens' Invitation (Maybe InvitationStatus) Source #

The status of the invitation:

  • PENDING - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.
  • ACCEPTING - The invitee has begun creating a member, and creation hasn't yet completed.
  • ACCEPTED - The invitee created a member and joined the network using the InvitationID.
  • REJECTED - The invitee rejected the invitation.
  • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate.