invitations

Creates, updates, deletes, gets or lists an invitations resource.

Overview

Name	invitations
Type	Resource
Id	aws.managedblockchain.invitations

Fields

The following fields are returned by SELECT queries:

list_invitations

Name	Datatype	Description
invitations	array	The invitations for the network.
next_token	string	The pagination token that indicates the next set of results to retrieve.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_invitations	select	region	maxResults, nextToken	Returns a list of all invitations for the current Amazon Web Services account. Applies only to Hyperledger Fabric.
reject_invitation	exec	invitation_id, region		Rejects an invitation to join a network. This action can be called by a principal in an Amazon Web Services account that has received an invitation to create a member and join a network. Applies only to Hyperledger Fabric.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
invitation_id	string	The unique identifier of the invitation to reject.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of invitations to return.
nextToken	string	The pagination token that indicates the next set of results to retrieve.

SELECT examples

list_invitations

Returns a list of all invitations for the current Amazon Web Services account. Applies only to Hyperledger Fabric.

SELECT
invitations,
next_token
FROM aws.managedblockchain.invitations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

Lifecycle Methods

reject_invitation

Rejects an invitation to join a network. This action can be called by a principal in an Amazon Web Services account that has received an invitation to create a member and join a network. Applies only to Hyperledger Fabric.

EXEC aws.managedblockchain.invitations.reject_invitation 
@invitation_id='{{ invitation_id }}' --required, 
@region='{{ region }}' --required
;