Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- data Invitation = Invitation' {}
- newInvitation :: Invitation
- invitation_status :: Lens' Invitation (Maybe InvitationStatus)
- invitation_arn :: Lens' Invitation (Maybe Text)
- invitation_invitationId :: Lens' Invitation (Maybe Text)
- invitation_expirationDate :: Lens' Invitation (Maybe UTCTime)
- invitation_networkSummary :: Lens' Invitation (Maybe NetworkSummary)
- invitation_creationDate :: Lens' Invitation (Maybe UTCTime)
Documentation
data Invitation Source #
An invitation to an AWS account to create a member and join the network.
Applies only to Hyperledger Fabric.
See: newInvitation
smart constructor.
Invitation' | |
|
Instances
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:
$sel:status:Invitation'
, invitation_status
- The status of the invitation:
PENDING
- The invitee has not created a member to join the network, and the invitation has not yet expired.ACCEPTING
- The invitee has begun creating a member, and creation has not yet completed.ACCEPTED
- The invitee created a member and joined the network using theInvitationID
.REJECTED
- The invitee rejected the invitation.EXPIRED
- The invitee neither created a member nor rejected the invitation before theExpirationDate
.
$sel:arn: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 AWS General Reference.
$sel:invitationId:Invitation'
, invitation_invitationId
- The unique identifier for the invitation.
$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:networkSummary:Invitation'
, invitation_networkSummary
- Undocumented member.
$sel:creationDate:Invitation'
, invitation_creationDate
- The date and time that the invitation was created.
invitation_status :: Lens' Invitation (Maybe InvitationStatus) Source #
The status of the invitation:
PENDING
- The invitee has not created a member to join the network, and the invitation has not yet expired.ACCEPTING
- The invitee has begun creating a member, and creation has not yet completed.ACCEPTED
- The invitee created a member and joined the network using theInvitationID
.REJECTED
- The invitee rejected the invitation.EXPIRED
- The invitee neither created a member nor rejected the invitation before theExpirationDate
.
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 AWS General Reference.
invitation_invitationId :: Lens' Invitation (Maybe Text) Source #
The unique identifier for the invitation.
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_networkSummary :: Lens' Invitation (Maybe NetworkSummary) Source #
Undocumented member.
invitation_creationDate :: Lens' Invitation (Maybe UTCTime) Source #
The date and time that the invitation was created.