ManagedBlockchain

Table of Contents

Client

class ManagedBlockchain.Client

A low-level client representing Amazon Managed Blockchain (ManagedBlockchain):

client = session.create_client('managedblockchain')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_member(**kwargs)

Creates a member within a Managed Blockchain network.

See also: AWS API Documentation

Request Syntax

response = client.create_member(
    ClientRequestToken='string',
    InvitationId='string',
    NetworkId='string',
    MemberConfiguration={
        'Name': 'string',
        'Description': 'string',
        'FrameworkConfiguration': {
            'Fabric': {
                'AdminUsername': 'string',
                'AdminPassword': 'string'
            }
        }
    }
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

    This field is autopopulated if not provided.

  • InvitationId (string) --

    [REQUIRED]

    The unique identifier of the invitation that is sent to the member to join the network.

  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network in which the member is created.

  • MemberConfiguration (dict) --

    [REQUIRED]

    Member configuration parameters.

    • Name (string) -- [REQUIRED]

      The name of the member.

    • Description (string) --

      An optional description of the member.

    • FrameworkConfiguration (dict) -- [REQUIRED]

      Configuration properties of the blockchain framework relevant to the member.

      • Fabric (dict) --

        Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.

        • AdminUsername (string) -- [REQUIRED]

          The user name for the member's initial administrative user.

        • AdminPassword (string) -- [REQUIRED]

          The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quote(‘), double quote(“), forward slash(/), backward slash(), @, or a space.

Return type

dict

Returns

Response Syntax

{
    'MemberId': 'string'
}

Response Structure

  • (dict) --

    • MemberId (string) --

      The unique identifier of the member.

create_network(**kwargs)

Creates a new blockchain network using Amazon Managed Blockchain.

See also: AWS API Documentation

Request Syntax

response = client.create_network(
    ClientRequestToken='string',
    Name='string',
    Description='string',
    Framework='HYPERLEDGER_FABRIC',
    FrameworkVersion='string',
    FrameworkConfiguration={
        'Fabric': {
            'Edition': 'STARTER'|'STANDARD'
        }
    },
    VotingPolicy={
        'ApprovalThresholdPolicy': {
            'ThresholdPercentage': 123,
            'ProposalDurationInHours': 123,
            'ThresholdComparator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUAL_TO'
        }
    },
    MemberConfiguration={
        'Name': 'string',
        'Description': 'string',
        'FrameworkConfiguration': {
            'Fabric': {
                'AdminUsername': 'string',
                'AdminPassword': 'string'
            }
        }
    }
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

    This field is autopopulated if not provided.

  • Name (string) --

    [REQUIRED]

    The name of the network.

  • Description (string) -- An optional description for the network.
  • Framework (string) --

    [REQUIRED]

    The blockchain framework that the network uses.

  • FrameworkVersion (string) --

    [REQUIRED]

    The version of the blockchain framework that the network uses.

  • FrameworkConfiguration (dict) --

    Configuration properties of the blockchain framework relevant to the network configuration.

    • Fabric (dict) --

      Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric.

  • VotingPolicy (dict) --

    [REQUIRED]

    The voting rules used by the network to determine if a proposal is approved.

    • ApprovalThresholdPolicy (dict) --

      Defines the rules for the network for voting on proposals, such as the percentage of YES votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

      • ThresholdPercentage (integer) --

        The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN , this indicates that 6 YES votes are required for the proposal to be approved.

      • ProposalDurationInHours (integer) --

        The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions are not carried out.

      • ThresholdComparator (string) --

        Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.

  • MemberConfiguration (dict) --

    [REQUIRED]

    Configuration properties for the first member within the network.

    • Name (string) -- [REQUIRED]

      The name of the member.

    • Description (string) --

      An optional description of the member.

    • FrameworkConfiguration (dict) -- [REQUIRED]

      Configuration properties of the blockchain framework relevant to the member.

      • Fabric (dict) --

        Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.

        • AdminUsername (string) -- [REQUIRED]

          The user name for the member's initial administrative user.

        • AdminPassword (string) -- [REQUIRED]

          The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quote(‘), double quote(“), forward slash(/), backward slash(), @, or a space.

Return type

dict

Returns

Response Syntax

{
    'NetworkId': 'string',
    'MemberId': 'string'
}

Response Structure

  • (dict) --

    • NetworkId (string) --

      The unique identifier for the network.

    • MemberId (string) --

      The unique identifier for the first member within the network.

create_node(**kwargs)

Creates a peer node in a member.

See also: AWS API Documentation

Request Syntax

response = client.create_node(
    ClientRequestToken='string',
    NetworkId='string',
    MemberId='string',
    NodeConfiguration={
        'InstanceType': 'string',
        'AvailabilityZone': 'string'
    }
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

    This field is autopopulated if not provided.

  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network in which this node runs.

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member that owns this node.

  • NodeConfiguration (dict) --

    [REQUIRED]

    The properties of a node configuration.

    • InstanceType (string) -- [REQUIRED]

      The Amazon Managed Blockchain instance type for the node.

    • AvailabilityZone (string) -- [REQUIRED]

      The Availability Zone in which the node exists.

Return type

dict

Returns

Response Syntax

{
    'NodeId': 'string'
}

Response Structure

  • (dict) --

    • NodeId (string) --

      The unique identifier of the node.

create_proposal(**kwargs)

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

See also: AWS API Documentation

Request Syntax

response = client.create_proposal(
    ClientRequestToken='string',
    NetworkId='string',
    MemberId='string',
    Actions={
        'Invitations': [
            {
                'Principal': 'string'
            },
        ],
        'Removals': [
            {
                'MemberId': 'string'
            },
        ]
    },
    Description='string'
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

    This field is autopopulated if not provided.

  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network for which the proposal is made.

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single AWS account.

  • Actions (dict) --

    [REQUIRED]

    The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions.

    • Invitations (list) --

      The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join the network.

      • (dict) --

        An action to invite a specific AWS account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED .

        • Principal (string) -- [REQUIRED]

          The AWS account ID to invite.

    • Removals (list) --

      The actions to perform for an APPROVED proposal to remove a member from the network, which deletes the member and all associated member resources from the network.

      • (dict) --

        An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED . The member and all associated resources are deleted from the network.

        • MemberId (string) -- [REQUIRED]

          The unique identifier of the member to remove.

  • Description (string) -- A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."
Return type

dict

Returns

Response Syntax

{
    'ProposalId': 'string'
}

Response Structure

  • (dict) --

    • ProposalId (string) --

      The unique identifier of the proposal.

delete_member(**kwargs)

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also.

See also: AWS API Documentation

Request Syntax

response = client.delete_member(
    NetworkId='string',
    MemberId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network from which the member is removed.

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member to remove.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_node(**kwargs)

Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered.

See also: AWS API Documentation

Request Syntax

response = client.delete_node(
    NetworkId='string',
    MemberId='string',
    NodeId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network that the node belongs to.

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member that owns this node.

  • NodeId (string) --

    [REQUIRED]

    The unique identifier of the node.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_member(**kwargs)

Returns detailed information about a member.

See also: AWS API Documentation

Request Syntax

response = client.get_member(
    NetworkId='string',
    MemberId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network to which the member belongs.

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member.

Return type

dict

Returns

Response Syntax

{
    'Member': {
        'NetworkId': 'string',
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'FrameworkAttributes': {
            'Fabric': {
                'AdminUsername': 'string',
                'CaEndpoint': 'string'
            }
        },
        'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
        'CreationDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Member (dict) --

      The properties of a member.

      • NetworkId (string) --

        The unique identifier of the network to which the member belongs.

      • Id (string) --

        The unique identifier of the member.

      • Name (string) --

        The name of the member.

      • Description (string) --

        An optional description for the member.

      • FrameworkAttributes (dict) --

        Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

        • Fabric (dict) --

          Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger Fabric.

          • AdminUsername (string) --

            The user name for the initial administrator user for the member.

          • CaEndpoint (string) --

            The endpoint used to access the member's certificate authority.

      • Status (string) --

        The status of a member.

        • CREATING - The AWS account is in the process of creating a member.
        • AVAILABLE - The member has been created and can participate in the network.
        • CREATE_FAILED - The AWS account attempted to create a member and creation failed.
        • DELETING - The member and all associated resources are in the process of being deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
        • DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
      • CreationDate (datetime) --

        The date and time that the member was created.

get_network(**kwargs)

Returns detailed information about a network.

See also: AWS API Documentation

Request Syntax

response = client.get_network(
    NetworkId='string'
)
Parameters
NetworkId (string) --

[REQUIRED]

The unique identifier of the network to get information about.

Return type
dict
Returns
Response Syntax
{
    'Network': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Framework': 'HYPERLEDGER_FABRIC',
        'FrameworkVersion': 'string',
        'FrameworkAttributes': {
            'Fabric': {
                'OrderingServiceEndpoint': 'string',
                'Edition': 'STARTER'|'STANDARD'
            }
        },
        'VpcEndpointServiceName': 'string',
        'VotingPolicy': {
            'ApprovalThresholdPolicy': {
                'ThresholdPercentage': 123,
                'ProposalDurationInHours': 123,
                'ThresholdComparator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUAL_TO'
            }
        },
        'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
        'CreationDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --
    • Network (dict) --

      An object containing network configuration parameters.

      • Id (string) --

        The unique identifier of the network.

      • Name (string) --

        The name of the network.

      • Description (string) --

        Attributes of the blockchain framework for the network.

      • Framework (string) --

        The blockchain framework that the network uses.

      • FrameworkVersion (string) --

        The version of the blockchain framework that the network uses.

      • FrameworkAttributes (dict) --

        Attributes of the blockchain framework that the network uses.

        • Fabric (dict) --

          Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric.

          • OrderingServiceEndpoint (string) --

            The endpoint of the ordering service for the network.

          • Edition (string) --

            The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing .

      • VpcEndpointServiceName (string) --

        The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service name to create a VPC endpoint to access network resources.

      • VotingPolicy (dict) --

        The voting rules for the network to decide if a proposal is accepted.

        • ApprovalThresholdPolicy (dict) --

          Defines the rules for the network for voting on proposals, such as the percentage of YES votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

          • ThresholdPercentage (integer) --

            The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN , this indicates that 6 YES votes are required for the proposal to be approved.

          • ProposalDurationInHours (integer) --

            The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions are not carried out.

          • ThresholdComparator (string) --

            Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.

      • Status (string) --

        The current status of the network.

      • CreationDate (datetime) --

        The date and time that the network was created.

get_node(**kwargs)

Returns detailed information about a peer node.

See also: AWS API Documentation

Request Syntax

response = client.get_node(
    NetworkId='string',
    MemberId='string',
    NodeId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network to which the node belongs.

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member that owns the node.

  • NodeId (string) --

    [REQUIRED]

    The unique identifier of the node.

Return type

dict

Returns

Response Syntax

{
    'Node': {
        'NetworkId': 'string',
        'MemberId': 'string',
        'Id': 'string',
        'InstanceType': 'string',
        'AvailabilityZone': 'string',
        'FrameworkAttributes': {
            'Fabric': {
                'PeerEndpoint': 'string',
                'PeerEventEndpoint': 'string'
            }
        },
        'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED'|'FAILED',
        'CreationDate': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) --

    • Node (dict) --

      Properties of the node configuration.

      • NetworkId (string) --

        The unique identifier of the network that the node is in.

      • MemberId (string) --

        The unique identifier of the member to which the node belongs.

      • Id (string) --

        The unique identifier of the node.

      • InstanceType (string) --

        The instance type of the node.

      • AvailabilityZone (string) --

        The Availability Zone in which the node exists.

      • FrameworkAttributes (dict) --

        Attributes of the blockchain framework being used.

        • Fabric (dict) --

          Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.

          • PeerEndpoint (string) --

            The endpoint that identifies the peer node for all services except peer channel-based event services.

          • PeerEventEndpoint (string) --

            The endpoint that identifies the peer node for peer channel-based event services.

      • Status (string) --

        The status of the node.

      • CreationDate (datetime) --

        The date and time that the node was created.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_proposal(**kwargs)

Returns detailed information about a proposal.

See also: AWS API Documentation

Request Syntax

response = client.get_proposal(
    NetworkId='string',
    ProposalId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network for which the proposal is made.

  • ProposalId (string) --

    [REQUIRED]

    The unique identifier of the proposal.

Return type

dict

Returns

Response Syntax

{
    'Proposal': {
        'ProposalId': 'string',
        'NetworkId': 'string',
        'Description': 'string',
        'Actions': {
            'Invitations': [
                {
                    'Principal': 'string'
                },
            ],
            'Removals': [
                {
                    'MemberId': 'string'
                },
            ]
        },
        'ProposedByMemberId': 'string',
        'ProposedByMemberName': 'string',
        'Status': 'IN_PROGRESS'|'APPROVED'|'REJECTED'|'EXPIRED'|'ACTION_FAILED',
        'CreationDate': datetime(2015, 1, 1),
        'ExpirationDate': datetime(2015, 1, 1),
        'YesVoteCount': 123,
        'NoVoteCount': 123,
        'OutstandingVoteCount': 123
    }
}

Response Structure

  • (dict) --

    • Proposal (dict) --

      Information about a proposal.

      • ProposalId (string) --

        The unique identifier of the proposal.

      • NetworkId (string) --

        The unique identifier of the network for which the proposal is made.

      • Description (string) --

        The description of the proposal.

      • Actions (dict) --

        The actions to perform on the network if the proposal is APPROVED .

        • Invitations (list) --

          The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join the network.

          • (dict) --

            An action to invite a specific AWS account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED .

            • Principal (string) --

              The AWS account ID to invite.

        • Removals (list) --

          The actions to perform for an APPROVED proposal to remove a member from the network, which deletes the member and all associated member resources from the network.

          • (dict) --

            An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED . The member and all associated resources are deleted from the network.

            • MemberId (string) --

              The unique identifier of the member to remove.

      • ProposedByMemberId (string) --

        The unique identifier of the member that created the proposal.

      • ProposedByMemberName (string) --

        The name of the member that created the proposal.

      • Status (string) --

        The status of the proposal. Values are as follows:

        • IN_PROGRESS - The proposal is active and open for member voting.
        • APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network . The specified proposal actions are carried out.
        • REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network . The specified ProposalActions are not carried out.
        • EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
        • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
      • CreationDate (datetime) --

        The date and time that the proposal was created.

      • ExpirationDate (datetime) --

        The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy . After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.

      • YesVoteCount (integer) --

        The current total of YES votes cast on the proposal by members.

      • NoVoteCount (integer) --

        The current total of NO votes cast on the proposal by members.

      • OutstandingVoteCount (integer) --

        The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of YES votes and NO votes.

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_invitations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_invitations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of invitations to return.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Invitations': [
        {
            'InvitationId': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'ExpirationDate': datetime(2015, 1, 1),
            'Status': 'PENDING'|'ACCEPTED'|'ACCEPTING'|'REJECTED'|'EXPIRED',
            'NetworkSummary': {
                'Id': 'string',
                'Name': 'string',
                'Description': 'string',
                'Framework': 'HYPERLEDGER_FABRIC',
                'FrameworkVersion': 'string',
                'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
                'CreationDate': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Invitations (list) --

      The invitations for the network.

      • (dict) --

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

        • InvitationId (string) --

          The unique identifier for the invitation.

        • CreationDate (datetime) --

          The date and time that the invitation was created.

        • ExpirationDate (datetime) --

          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 (dict) --

          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 (datetime) --

            The date and time that the network was created.

    • NextToken (string) --

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

list_members(**kwargs)

Returns a listing of the members in a network and properties of their configurations.

See also: AWS API Documentation

Request Syntax

response = client.list_members(
    NetworkId='string',
    Name='string',
    Status='CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
    IsOwned=True|False,
    MaxResults=123,
    NextToken='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network for which to list members.

  • Name (string) -- The optional name of the member to list.
  • Status (string) -- An optional status specifier. If provided, only members currently in this status are listed.
  • IsOwned (boolean) -- An optional Boolean value. If provided, the request is limited either to members that the current AWS account owns (true ) or that other AWS accounts own (false ). If omitted, all members are listed.
  • MaxResults (integer) -- The maximum number of members to return in the request.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Members': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
            'CreationDate': datetime(2015, 1, 1),
            'IsOwned': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Members (list) --

      An array of MemberSummary objects. Each object contains details about a network member.

      • (dict) --

        A summary of configuration properties for a member.

        • Id (string) --

          The unique identifier of the member.

        • Name (string) --

          The name of the member.

        • Description (string) --

          An optional description of the member.

        • Status (string) --

          The status of the member.

          • CREATING - The AWS account is in the process of creating a member.
          • AVAILABLE - The member has been created and can participate in the network.
          • CREATE_FAILED - The AWS account attempted to create a member and creation failed.
          • DELETING - The member and all associated resources are in the process of being deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
          • DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
        • CreationDate (datetime) --

          The date and time that the member was created.

        • IsOwned (boolean) --

          An indicator of whether the member is owned by your AWS account or a different AWS account.

    • NextToken (string) --

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

list_networks(**kwargs)

Returns information about the networks in which the current AWS account has members.

See also: AWS API Documentation

Request Syntax

response = client.list_networks(
    Name='string',
    Framework='HYPERLEDGER_FABRIC',
    Status='CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Name (string) -- The name of the network.
  • Framework (string) -- An optional framework specifier. If provided, only networks of this framework type are listed.
  • Status (string) -- An optional status specifier. If provided, only networks currently in this status are listed.
  • MaxResults (integer) -- The maximum number of networks to list.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Networks': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'Framework': 'HYPERLEDGER_FABRIC',
            'FrameworkVersion': 'string',
            'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
            'CreationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Networks (list) --

      An array of NetworkSummary objects that contain configuration properties for each network.

      • (dict) --

        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 (datetime) --

          The date and time that the network was created.

    • NextToken (string) --

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

list_nodes(**kwargs)

Returns information about the nodes within a network.

See also: AWS API Documentation

Request Syntax

response = client.list_nodes(
    NetworkId='string',
    MemberId='string',
    Status='CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED'|'FAILED',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network for which to list nodes.

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member who owns the nodes to list.

  • Status (string) -- An optional status specifier. If provided, only nodes currently in this status are listed.
  • MaxResults (integer) -- The maximum number of nodes to list.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Nodes': [
        {
            'Id': 'string',
            'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED'|'FAILED',
            'CreationDate': datetime(2015, 1, 1),
            'AvailabilityZone': 'string',
            'InstanceType': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Nodes (list) --

      An array of NodeSummary objects that contain configuration properties for each node.

      • (dict) --

        A summary of configuration properties for a peer node.

        • Id (string) --

          The unique identifier of the node.

        • Status (string) --

          The status of the node.

        • CreationDate (datetime) --

          The date and time that the node was created.

        • AvailabilityZone (string) --

          The Availability Zone in which the node exists.

        • InstanceType (string) --

          The EC2 instance type for the node.

    • NextToken (string) --

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

list_proposal_votes(**kwargs)

Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

See also: AWS API Documentation

Request Syntax

response = client.list_proposal_votes(
    NetworkId='string',
    ProposalId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network.

  • ProposalId (string) --

    [REQUIRED]

    The unique identifier of the proposal.

  • MaxResults (integer) -- The maximum number of votes to return.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'ProposalVotes': [
        {
            'Vote': 'YES'|'NO',
            'MemberName': 'string',
            'MemberId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ProposalVotes (list) --

      The listing of votes.

      • (dict) --

        Properties of an individual vote that a member cast for a proposal.

        • Vote (string) --

          The vote value, either YES or NO .

        • MemberName (string) --

          The name of the member that cast the vote.

        • MemberId (string) --

          The unique identifier of the member that cast the vote.

    • NextToken (string) --

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

list_proposals(**kwargs)

Returns a listing of proposals for the network.

See also: AWS API Documentation

Request Syntax

response = client.list_proposals(
    NetworkId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network.

  • MaxResults (integer) -- The maximum number of proposals to return.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Proposals': [
        {
            'ProposalId': 'string',
            'Description': 'string',
            'ProposedByMemberId': 'string',
            'ProposedByMemberName': 'string',
            'Status': 'IN_PROGRESS'|'APPROVED'|'REJECTED'|'EXPIRED'|'ACTION_FAILED',
            'CreationDate': datetime(2015, 1, 1),
            'ExpirationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Proposals (list) --

      The summary of each proposal made on the network.

      • (dict) --

        Properties of a proposal.

        • ProposalId (string) --

          The unique identifier of the proposal.

        • Description (string) --

          The description of the proposal.

        • ProposedByMemberId (string) --

          The unique identifier of the member that created the proposal.

        • ProposedByMemberName (string) --

          The name of the member that created the proposal.

        • Status (string) --

          The status of the proposal. Values are as follows:

          • IN_PROGRESS - The proposal is active and open for member voting.
          • APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network . The specified proposal actions are carried out.
          • REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network . The specified ProposalActions are not carried out.
          • EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.
          • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.
        • CreationDate (datetime) --

          The date and time that the proposal was created.

        • ExpirationDate (datetime) --

          The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy . After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.

    • NextToken (string) --

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

reject_invitation(**kwargs)

Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.

See also: AWS API Documentation

Request Syntax

response = client.reject_invitation(
    InvitationId='string'
)
Parameters
InvitationId (string) --

[REQUIRED]

The unique identifier of the invitation to reject.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
vote_on_proposal(**kwargs)

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId , must be in the same AWS account as the principal that calls the action.

See also: AWS API Documentation

Request Syntax

response = client.vote_on_proposal(
    NetworkId='string',
    ProposalId='string',
    VoterMemberId='string',
    Vote='YES'|'NO'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network.

  • ProposalId (string) --

    [REQUIRED]

    The unique identifier of the proposal.

  • VoterMemberId (string) --

    [REQUIRED]

    The unique identifier of the member casting the vote.

  • Vote (string) --

    [REQUIRED]

    The value of the vote.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Paginators

The available paginators are: