Table of Contents
A low-level client representing Amazon Managed Blockchain (ManagedBlockchain):
import boto3
client = boto3.client('managedblockchain')
These are the available methods:
Check if an operation can be paginated.
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'
}
},
'LogPublishingConfiguration': {
'Fabric': {
'CaLogs': {
'Cloudwatch': {
'Enabled': True|False
}
}
}
}
}
)
[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.
[REQUIRED]
The unique identifier of the invitation that is sent to the member to join the network.
[REQUIRED]
The unique identifier of the network in which the member is created.
[REQUIRED]
Member configuration parameters.
The name of the member.
An optional description of the member.
Configuration properties of the blockchain framework relevant to the member.
Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.
The user name for the member's initial administrative user.
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.
Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.
Parameters for publishing logs to Amazon CloudWatch Logs.
Indicates whether logging is enabled.
dict
Response Syntax
{
'MemberId': 'string'
}
Response Structure
(dict) --
MemberId (string) --
The unique identifier of the member.
Exceptions
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'
}
},
'LogPublishingConfiguration': {
'Fabric': {
'CaLogs': {
'Cloudwatch': {
'Enabled': True|False
}
}
}
}
}
)
[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.
[REQUIRED]
The name of the network.
[REQUIRED]
The blockchain framework that the network uses.
[REQUIRED]
The version of the blockchain framework that the network uses.
Configuration properties of the blockchain framework relevant to the network configuration.
Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric.
The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing .
[REQUIRED]
The voting rules used by the network to determine if a proposal is approved.
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.
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.
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.
Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.
[REQUIRED]
Configuration properties for the first member within the network.
The name of the member.
An optional description of the member.
Configuration properties of the blockchain framework relevant to the member.
Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.
The user name for the member's initial administrative user.
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.
Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.
Parameters for publishing logs to Amazon CloudWatch Logs.
Indicates whether logging is enabled.
dict
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.
Exceptions
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',
'LogPublishingConfiguration': {
'Fabric': {
'ChaincodeLogs': {
'Cloudwatch': {
'Enabled': True|False
}
},
'PeerLogs': {
'Cloudwatch': {
'Enabled': True|False
}
}
}
}
}
)
[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.
[REQUIRED]
The unique identifier of the network in which this node runs.
[REQUIRED]
The unique identifier of the member that owns this node.
[REQUIRED]
The properties of a node configuration.
The Amazon Managed Blockchain instance type for the node.
The Availability Zone in which the node exists.
Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.
Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.
Parameters for publishing logs to Amazon CloudWatch Logs.
Indicates whether logging is enabled.
Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.
Parameters for publishing logs to Amazon CloudWatch Logs.
Indicates whether logging is enabled.
dict
Response Syntax
{
'NodeId': 'string'
}
Response Structure
(dict) --
NodeId (string) --
The unique identifier of the node.
Exceptions
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'
)
[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.
[REQUIRED]
The unique identifier of the network for which the proposal is made.
[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.
[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.
The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join the network.
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 .
The AWS account ID to invite.
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.
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.
The unique identifier of the member to remove.
dict
Response Syntax
{
'ProposalId': 'string'
}
Response Structure
(dict) --
ProposalId (string) --
The unique identifier of the proposal.
Exceptions
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'
)
[REQUIRED]
The unique identifier of the network from which the member is removed.
[REQUIRED]
The unique identifier of the member to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
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'
)
[REQUIRED]
The unique identifier of the network that the node belongs to.
[REQUIRED]
The unique identifier of the member that owns this node.
[REQUIRED]
The unique identifier of the node.
dict
Response Syntax
{}
Response Structure
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Returns detailed information about a member.
See also: AWS API Documentation
Request Syntax
response = client.get_member(
NetworkId='string',
MemberId='string'
)
[REQUIRED]
The unique identifier of the network to which the member belongs.
[REQUIRED]
The unique identifier of the member.
dict
Response Syntax
{
'Member': {
'NetworkId': 'string',
'Id': 'string',
'Name': 'string',
'Description': 'string',
'FrameworkAttributes': {
'Fabric': {
'AdminUsername': 'string',
'CaEndpoint': 'string'
}
},
'LogPublishingConfiguration': {
'Fabric': {
'CaLogs': {
'Cloudwatch': {
'Enabled': True|False
}
}
}
},
'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'UPDATING'|'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.
LogPublishingConfiguration (dict) --
Configuration properties for logging events associated with a member.
Fabric (dict) --
Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
CaLogs (dict) --
Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.
Cloudwatch (dict) --
Parameters for publishing logs to Amazon CloudWatch Logs.
Enabled (boolean) --
Indicates whether logging is enabled.
Status (string) --
The status of a member.
CreationDate (datetime) --
The date and time that the member was created.
Exceptions
Returns detailed information about a network.
See also: AWS API Documentation
Request Syntax
response = client.get_network(
NetworkId='string'
)
[REQUIRED]
The unique identifier of the network to get information about.
{
'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
An object containing network configuration parameters.
The unique identifier of the network.
The name of the network.
Attributes of the blockchain framework for the network.
The blockchain framework that the network uses.
The version of the blockchain framework that the network uses.
Attributes of the blockchain framework that the network uses.
Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric.
The endpoint of the ordering service for the network.
The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing .
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.
The voting rules for the network to decide if a proposal is accepted.
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.
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.
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.
Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.
The current status of the network.
The date and time that the network was created.
Exceptions
Returns detailed information about a peer node.
See also: AWS API Documentation
Request Syntax
response = client.get_node(
NetworkId='string',
MemberId='string',
NodeId='string'
)
[REQUIRED]
The unique identifier of the network to which the node belongs.
[REQUIRED]
The unique identifier of the member that owns the node.
[REQUIRED]
The unique identifier of the node.
dict
Response Syntax
{
'Node': {
'NetworkId': 'string',
'MemberId': 'string',
'Id': 'string',
'InstanceType': 'string',
'AvailabilityZone': 'string',
'FrameworkAttributes': {
'Fabric': {
'PeerEndpoint': 'string',
'PeerEventEndpoint': 'string'
}
},
'LogPublishingConfiguration': {
'Fabric': {
'ChaincodeLogs': {
'Cloudwatch': {
'Enabled': True|False
}
},
'PeerLogs': {
'Cloudwatch': {
'Enabled': True|False
}
}
}
},
'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'UPDATING'|'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.
LogPublishingConfiguration (dict) --
Fabric (dict) --
Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.
ChaincodeLogs (dict) --
Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.
Cloudwatch (dict) --
Parameters for publishing logs to Amazon CloudWatch Logs.
Enabled (boolean) --
Indicates whether logging is enabled.
PeerLogs (dict) --
Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.
Cloudwatch (dict) --
Parameters for publishing logs to Amazon CloudWatch Logs.
Enabled (boolean) --
Indicates whether logging is enabled.
Status (string) --
The status of the node.
CreationDate (datetime) --
The date and time that the node was created.
Exceptions
Create a paginator for an operation.
Returns detailed information about a proposal.
See also: AWS API Documentation
Request Syntax
response = client.get_proposal(
NetworkId='string',
ProposalId='string'
)
[REQUIRED]
The unique identifier of the network for which the proposal is made.
[REQUIRED]
The unique identifier of the proposal.
dict
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:
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.
Exceptions
Returns an object that can wait for some condition.
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'
)
dict
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:
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.
Exceptions
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'|'UPDATING'|'DELETING'|'DELETED',
IsOwned=True|False,
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The unique identifier of the network for which to list members.
dict
Response Syntax
{
'Members': [
{
'Id': 'string',
'Name': 'string',
'Description': 'string',
'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'UPDATING'|'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.
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.
Exceptions
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'
)
dict
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.
Exceptions
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'|'UPDATING'|'DELETING'|'DELETED'|'FAILED',
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The unique identifier of the network for which to list nodes.
[REQUIRED]
The unique identifier of the member who owns the nodes to list.
dict
Response Syntax
{
'Nodes': [
{
'Id': 'string',
'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'UPDATING'|'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.
Exceptions
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'
)
[REQUIRED]
The unique identifier of the network.
[REQUIRED]
The unique identifier of the proposal.
dict
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.
Exceptions
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'
)
[REQUIRED]
The unique identifier of the network.
dict
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:
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.
Exceptions
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'
)
[REQUIRED]
The unique identifier of the invitation to reject.
{}
Response Structure
Exceptions
Updates a member configuration with new parameters.
See also: AWS API Documentation
Request Syntax
response = client.update_member(
NetworkId='string',
MemberId='string',
LogPublishingConfiguration={
'Fabric': {
'CaLogs': {
'Cloudwatch': {
'Enabled': True|False
}
}
}
}
)
[REQUIRED]
The unique ID of the Managed Blockchain network to which the member belongs.
[REQUIRED]
The unique ID of the member.
Configuration properties for publishing to Amazon CloudWatch Logs.
Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.
Parameters for publishing logs to Amazon CloudWatch Logs.
Indicates whether logging is enabled.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a node configuration with new parameters.
See also: AWS API Documentation
Request Syntax
response = client.update_node(
NetworkId='string',
MemberId='string',
NodeId='string',
LogPublishingConfiguration={
'Fabric': {
'ChaincodeLogs': {
'Cloudwatch': {
'Enabled': True|False
}
},
'PeerLogs': {
'Cloudwatch': {
'Enabled': True|False
}
}
}
}
)
[REQUIRED]
The unique ID of the Managed Blockchain network to which the node belongs.
[REQUIRED]
The unique ID of the member that owns the node.
[REQUIRED]
The unique ID of the node.
Configuration properties for publishing to Amazon CloudWatch Logs.
Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.
Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.
Parameters for publishing logs to Amazon CloudWatch Logs.
Indicates whether logging is enabled.
Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.
Parameters for publishing logs to Amazon CloudWatch Logs.
Indicates whether logging is enabled.
dict
Response Syntax
{}
Response Structure
Exceptions
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'
)
[REQUIRED]
The unique identifier of the network.
[REQUIRED]
The unique identifier of the proposal.
[REQUIRED]
The unique identifier of the member casting the vote.
[REQUIRED]
The value of the vote.
dict
Response Syntax
{}
Response Structure
Exceptions
The available paginators are: