[ aws . managedblockchain ]

list-invitations

Description

Returns a listing of all invitations made on the specified network.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-invitations
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--max-results (integer)

The maximum number of invitations to return.

--next-token (string)

The pagination token that indicates the next set of results to retrieve.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

Invitations -> (list)

The invitations for the network.

(structure)

An invitation to an AWS account to create a member and join the network.

InvitationId -> (string)

The unique identifier for the invitation.

CreationDate -> (timestamp)

The date and time that the invitation was created.

ExpirationDate -> (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 .

Status -> (string)

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 the InvitationID .

• REJECTED - The invitee rejected the invitation.

• EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate .

NetworkSummary -> (structure)

A summary of network configuration properties.

Id -> (string)

The unique identifier of the network.

Name -> (string)

The name of the network.

Description -> (string)

An optional description of the network.

Framework -> (string)

The blockchain framework that the network uses.

FrameworkVersion -> (string)

The version of the blockchain framework that the network uses.

Status -> (string)

The current status of the network.

CreationDate -> (timestamp)

The date and time that the network was created.

NextToken -> (string)

The pagination token that indicates the next set of results to retrieve.