Skip to content

Invitation

Source code in docs_src/capo_managedblockchain/types/invitation.py
class Invitation(TypedDict, closed=True):
    invitation_id: NotRequired[
        "capo_managedblockchain.types.resource_id_string.ResourceIdString"
    ]
    """<p>The unique identifier for the invitation.</p>"""
    creation_date: NotRequired["capo_managedblockchain.types.timestamp.Timestamp"]
    """<p>The date and time that the invitation was created.</p>"""
    expiration_date: NotRequired["capo_managedblockchain.types.timestamp.Timestamp"]
    """<p>The date and time that the invitation expires. This is the <code>CreationDate</code> plus the <code>ProposalDurationInHours</code> that is specified in the <code>ProposalThresholdPolicy</code>. After this date and time, the invitee can no longer create a member and join the network using this <code>InvitationId</code>.</p>"""
    status: NotRequired[
        "capo_managedblockchain.types.invitation_status.InvitationStatus"
    ]
    """<p>The status of the invitation:</p> <ul> <li> <p> <code>PENDING</code> - The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.</p> </li> <li> <p> <code>ACCEPTING</code> - The invitee has begun creating a member, and creation hasn't yet completed.</p> </li> <li> <p> <code>ACCEPTED</code> - The invitee created a member and joined the network using the <code>InvitationID</code>.</p> </li> <li> <p> <code>REJECTED</code> - The invitee rejected the invitation.</p> </li> <li> <p> <code>EXPIRED</code> - The invitee neither created a member nor rejected the invitation before the <code>ExpirationDate</code>.</p> </li> </ul>"""
    network_summary: NotRequired[
        "capo_managedblockchain.types.network_summary.NetworkSummary"
    ]
    arn: NotRequired["capo_managedblockchain.types.arn_string.ArnString"]
    """<p>The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i>.</p>"""

arn instance-attribute

arn: NotRequired[ArnString]

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.

creation_date instance-attribute

creation_date: NotRequired[Timestamp]

The date and time that the invitation was created.

expiration_date instance-attribute

expiration_date: NotRequired[Timestamp]

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_id instance-attribute

invitation_id: NotRequired[ResourceIdString]

The unique identifier for the invitation.

network_summary instance-attribute

network_summary: NotRequired[NetworkSummary]

status instance-attribute

status: NotRequired[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.