AWS SDK for PHP 3.x

Client: Aws\ManagedBlockchain\ManagedBlockchainClient

Service ID: managedblockchain

Version: 2018-09-24

This page describes the parameters and results for the operations of the Amazon Managed Blockchain (2018-09-24), and shows how to use the Aws\ManagedBlockchain\ManagedBlockchainClient object to call the described operations. This documentation is specific to the 2018-09-24 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateAccessor ( array $params = [] )
The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change.
CreateMember ( array $params = [] )
Creates a member within a Managed Blockchain network.
CreateNetwork ( array $params = [] )
Creates a new blockchain network using Amazon Managed Blockchain.
CreateNode ( array $params = [] )
Creates a node on the specified blockchain network.
CreateProposal ( array $params = [] )
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.
DeleteAccessor ( array $params = [] )
The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change.
DeleteMember ( array $params = [] )
Deletes a member.
DeleteNode ( array $params = [] )
Deletes a node that your Amazon Web Services account owns.
GetAccessor ( array $params = [] )
The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change.
GetMember ( array $params = [] )
Returns detailed information about a member.
GetNetwork ( array $params = [] )
Returns detailed information about a network.
GetNode ( array $params = [] )
Returns detailed information about a node.
GetProposal ( array $params = [] )
Returns detailed information about a proposal.
ListAccessors ( array $params = [] )
The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change.
ListInvitations ( array $params = [] )
Returns a list of all invitations for the current Amazon Web Services account.
ListMembers ( array $params = [] )
Returns a list of the members in a network and properties of their configurations.
ListNetworks ( array $params = [] )
Returns information about the networks in which the current Amazon Web Services account participates.
ListNodes ( array $params = [] )
Returns information about the nodes within a network.
ListProposalVotes ( array $params = [] )
Returns the list of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.
ListProposals ( array $params = [] )
Returns a list of proposals for the network.
ListTagsForResource ( array $params = [] )
Returns a list of tags for the specified resource.
RejectInvitation ( array $params = [] )
Rejects an invitation to join a network.
TagResource ( array $params = [] )
Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource.
UntagResource ( array $params = [] )
Removes the specified tags from the Amazon Managed Blockchain resource.
UpdateMember ( array $params = [] )
Updates a member configuration with new parameters.
UpdateNode ( array $params = [] )
Updates a node configuration with new parameters.
VoteOnProposal ( array $params = [] )
Casts a vote for a specified ProposalId on behalf of a member.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListAccessors
ListInvitations
ListMembers
ListNetworks
ListNodes
ListProposalVotes
ListProposals

Operations

CreateAccessor

$result = $client->createAccessor([/* ... */]);
$promise = $client->createAccessorAsync([/* ... */]);

The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.

Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor object is a container that has the information required for token based access to your Ethereum nodes.

Parameter Syntax

$result = $client->createAccessor([
    'AccessorType' => 'BILLING_TOKEN', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessorType

Required: Yes
Type: string

The type of accessor.

Currently accessor type is restricted to BILLING_TOKEN.

ClientRequestToken

Required: Yes
Type: string

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

Result Syntax

[
    'AccessorId' => '<string>',
    'BillingToken' => '<string>',
]

Result Details

Members

AccessorId

Type: string

The unique identifier of the accessor.

BillingToken

Type: string

The billing token is a property of the Accessor. Use this token to make Ethereum API calls to your Ethereum node. The billing token is used to track your accessor object for billing Ethereum API requests made to your Ethereum nodes.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceAlreadyExistsException:
A resource request is issued for a resource that already exists.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
ResourceLimitExceededException:
The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

CreateMember

$result = $client->createMember([/* ... */]);
$promise = $client->createMemberAsync([/* ... */]);

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->createMember([
    'ClientRequestToken' => '<string>', // REQUIRED
    'InvitationId' => '<string>', // REQUIRED
    'MemberConfiguration' => [ // REQUIRED
        'Description' => '<string>',
        'FrameworkConfiguration' => [ // REQUIRED
            'Fabric' => [
                'AdminPassword' => '<string>', // REQUIRED
                'AdminUsername' => '<string>', // REQUIRED
            ],
        ],
        'KmsKeyArn' => '<string>',
        'LogPublishingConfiguration' => [
            'Fabric' => [
                'CaLogs' => [
                    'Cloudwatch' => [
                        'Enabled' => true || false,
                    ],
                ],
            ],
        ],
        'Name' => '<string>', // REQUIRED
        'Tags' => ['<string>', ...],
    ],
    'NetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Members

ClientRequestToken

Required: Yes
Type: string

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 Amazon Web Services SDK or the CLI.

InvitationId

Required: Yes
Type: string

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

MemberConfiguration

Required: Yes
Type: MemberConfiguration structure

Member configuration parameters.

NetworkId

Required: Yes
Type: string

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

Result Syntax

[
    'MemberId' => '<string>',
]

Result Details

Members

MemberId

Type: string

The unique identifier of the member.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ResourceAlreadyExistsException:
A resource request is issued for a resource that already exists.
ResourceNotReadyException:
The requested resource exists but isn't in a status that can complete the operation.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
ResourceLimitExceededException:
The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.
TooManyTagsException:

CreateNetwork

$result = $client->createNetwork([/* ... */]);
$promise = $client->createNetworkAsync([/* ... */]);

Creates a new blockchain network using Amazon Managed Blockchain.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->createNetwork([
    'ClientRequestToken' => '<string>', // REQUIRED
    'Description' => '<string>',
    'Framework' => 'HYPERLEDGER_FABRIC|ETHEREUM', // REQUIRED
    'FrameworkConfiguration' => [
        'Fabric' => [
            'Edition' => 'STARTER|STANDARD', // REQUIRED
        ],
    ],
    'FrameworkVersion' => '<string>', // REQUIRED
    'MemberConfiguration' => [ // REQUIRED
        'Description' => '<string>',
        'FrameworkConfiguration' => [ // REQUIRED
            'Fabric' => [
                'AdminPassword' => '<string>', // REQUIRED
                'AdminUsername' => '<string>', // REQUIRED
            ],
        ],
        'KmsKeyArn' => '<string>',
        'LogPublishingConfiguration' => [
            'Fabric' => [
                'CaLogs' => [
                    'Cloudwatch' => [
                        'Enabled' => true || false,
                    ],
                ],
            ],
        ],
        'Name' => '<string>', // REQUIRED
        'Tags' => ['<string>', ...],
    ],
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
    'VotingPolicy' => [ // REQUIRED
        'ApprovalThresholdPolicy' => [
            'ProposalDurationInHours' => <integer>,
            'ThresholdComparator' => 'GREATER_THAN|GREATER_THAN_OR_EQUAL_TO',
            'ThresholdPercentage' => <integer>,
        ],
    ],
]);

Parameter Details

Members

ClientRequestToken

Required: Yes
Type: string

Description

Type: string

An optional description for the network.

Framework

Required: Yes
Type: string

The blockchain framework that the network uses.

FrameworkConfiguration

Type: NetworkFrameworkConfiguration structure

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

FrameworkVersion

Required: Yes
Type: string

The version of the blockchain framework that the network uses.

MemberConfiguration

Required: Yes
Type: MemberConfiguration structure

Configuration properties for the first member within the network.

Name

Required: Yes
Type: string

The name of the network.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags to assign to the network. Each tag consists of a key and optional value.

When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

VotingPolicy

Required: Yes
Type: VotingPolicy structure

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

Result Syntax

[
    'MemberId' => '<string>',
    'NetworkId' => '<string>',
]

Result Details

Members

MemberId

Type: string

The unique identifier for the first member within the network.

NetworkId

Type: string

The unique identifier for the network.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceAlreadyExistsException:
A resource request is issued for a resource that already exists.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
ResourceLimitExceededException:
The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.
TooManyTagsException:

CreateNode

$result = $client->createNode([/* ... */]);
$promise = $client->createNodeAsync([/* ... */]);

Creates a node on the specified blockchain network.

Applies to Hyperledger Fabric and Ethereum.

Parameter Syntax

$result = $client->createNode([
    'ClientRequestToken' => '<string>', // REQUIRED
    'MemberId' => '<string>',
    'NetworkId' => '<string>', // REQUIRED
    'NodeConfiguration' => [ // REQUIRED
        'AvailabilityZone' => '<string>',
        'InstanceType' => '<string>', // REQUIRED
        'LogPublishingConfiguration' => [
            'Fabric' => [
                'ChaincodeLogs' => [
                    'Cloudwatch' => [
                        'Enabled' => true || false,
                    ],
                ],
                'PeerLogs' => [
                    'Cloudwatch' => [
                        'Enabled' => true || false,
                    ],
                ],
            ],
        ],
        'StateDB' => 'LevelDB|CouchDB',
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

ClientRequestToken

Required: Yes
Type: string

MemberId

Type: string

The unique identifier of the member that owns this node.

Applies only to Hyperledger Fabric.

NetworkId

Required: Yes
Type: string

The unique identifier of the network for the node.

Ethereum public networks have the following NetworkIds:

n-ethereum-mainnet
n-ethereum-goerli
n-ethereum-rinkeby
n-ethereum-ropsten

NodeConfiguration

Required: Yes
Type: NodeConfiguration structure

The properties of a node configuration.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags to assign to the node. Each tag consists of a key and optional value.

When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

Result Syntax

[
    'NodeId' => '<string>',
]

Result Details

Members

NodeId

Type: string

The unique identifier of the node.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ResourceAlreadyExistsException:
A resource request is issued for a resource that already exists.
ResourceNotReadyException:
The requested resource exists but isn't in a status that can complete the operation.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
ResourceLimitExceededException:
The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.
TooManyTagsException:

CreateProposal

$result = $client->createProposal([/* ... */]);
$promise = $client->createProposalAsync([/* ... */]);

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.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->createProposal([
    'Actions' => [ // REQUIRED
        'Invitations' => [
            [
                'Principal' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'Removals' => [
            [
                'MemberId' => '<string>', // REQUIRED
            ],
            // ...
        ],
    ],
    'ClientRequestToken' => '<string>', // REQUIRED
    'Description' => '<string>',
    'MemberId' => '<string>', // REQUIRED
    'NetworkId' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Actions

Required: Yes
Type: ProposalActions structure

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.

ClientRequestToken

Required: Yes
Type: string

Description

Type: string

A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."

MemberId

Required: Yes
Type: string

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 Amazon Web Services account.

NetworkId

Required: Yes
Type: string

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

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags to assign to the proposal. Each tag consists of a key and optional value.

When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.

Result Syntax

[
    'ProposalId' => '<string>',
]

Result Details

Members

ProposalId

Type: string

The unique identifier of the proposal.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ResourceNotReadyException:
The requested resource exists but isn't in a status that can complete the operation.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.
TooManyTagsException:

DeleteAccessor

$result = $client->deleteAccessor([/* ... */]);
$promise = $client->deleteAccessorAsync([/* ... */]);

Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN. After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION. An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).

Parameter Syntax

$result = $client->deleteAccessor([
    'AccessorId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessorId

Required: Yes
Type: string

The unique identifier of the accessor.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

DeleteMember

$result = $client->deleteMember([/* ... */]);
$promise = $client->deleteMemberAsync([/* ... */]);

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 Amazon Web Services 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 Amazon Web Services account, the network is deleted also.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->deleteMember([
    'MemberId' => '<string>', // REQUIRED
    'NetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MemberId

Required: Yes
Type: string

The unique identifier of the member to remove.

NetworkId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ResourceNotReadyException:
The requested resource exists but isn't in a status that can complete the operation.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

DeleteNode

$result = $client->deleteNode([/* ... */]);
$promise = $client->deleteNodeAsync([/* ... */]);

Deletes a node that your Amazon Web Services account owns. All data on the node is lost and cannot be recovered.

Applies to Hyperledger Fabric and Ethereum.

Parameter Syntax

$result = $client->deleteNode([
    'MemberId' => '<string>',
    'NetworkId' => '<string>', // REQUIRED
    'NodeId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MemberId

Type: string

The unique identifier of the member that owns this node.

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

NetworkId

Required: Yes
Type: string

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

Ethereum public networks have the following NetworkIds:

n-ethereum-mainnet
n-ethereum-goerli
n-ethereum-rinkeby
n-ethereum-ropsten

NodeId

Required: Yes
Type: string

The unique identifier of the node.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ResourceNotReadyException:
The requested resource exists but isn't in a status that can complete the operation.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

GetAccessor

$result = $client->getAccessor([/* ... */]);
$promise = $client->getAccessorAsync([/* ... */]);

Returns detailed information about an accessor. An accessor object is a container that has the information required for token based access to your Ethereum nodes.

Parameter Syntax

$result = $client->getAccessor([
    'AccessorId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccessorId

Required: Yes
Type: string

The unique identifier of the accessor.

Result Syntax

[
    'Accessor' => [
        'Arn' => '<string>',
        'BillingToken' => '<string>',
        'CreationDate' => <DateTime>,
        'Id' => '<string>',
        'Status' => 'AVAILABLE|PENDING_DELETION|DELETED',
        'Type' => 'BILLING_TOKEN',
    ],
]

Result Details

Members

Accessor

Type: Accessor structure

The properties of the accessor.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

GetMember

$result = $client->getMember([/* ... */]);
$promise = $client->getMemberAsync([/* ... */]);

Returns detailed information about a member.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->getMember([
    'MemberId' => '<string>', // REQUIRED
    'NetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MemberId

Required: Yes
Type: string

The unique identifier of the member.

NetworkId

Required: Yes
Type: string

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

Result Syntax

[
    'Member' => [
        'Arn' => '<string>',
        'CreationDate' => <DateTime>,
        'Description' => '<string>',
        'FrameworkAttributes' => [
            'Fabric' => [
                'AdminUsername' => '<string>',
                'CaEndpoint' => '<string>',
            ],
        ],
        'Id' => '<string>',
        'KmsKeyArn' => '<string>',
        'LogPublishingConfiguration' => [
            'Fabric' => [
                'CaLogs' => [
                    'Cloudwatch' => [
                        'Enabled' => true || false,
                    ],
                ],
            ],
        ],
        'Name' => '<string>',
        'NetworkId' => '<string>',
        'Status' => 'CREATING|AVAILABLE|CREATE_FAILED|UPDATING|DELETING|DELETED|INACCESSIBLE_ENCRYPTION_KEY',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

Member

Type: Member structure

The properties of a member.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

GetNetwork

$result = $client->getNetwork([/* ... */]);
$promise = $client->getNetworkAsync([/* ... */]);

Returns detailed information about a network.

Applies to Hyperledger Fabric and Ethereum.

Parameter Syntax

$result = $client->getNetwork([
    'NetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Members

NetworkId

Required: Yes
Type: string

The unique identifier of the network to get information about.

Result Syntax

[
    'Network' => [
        'Arn' => '<string>',
        'CreationDate' => <DateTime>,
        'Description' => '<string>',
        'Framework' => 'HYPERLEDGER_FABRIC|ETHEREUM',
        'FrameworkAttributes' => [
            'Ethereum' => [
                'ChainId' => '<string>',
            ],
            'Fabric' => [
                'Edition' => 'STARTER|STANDARD',
                'OrderingServiceEndpoint' => '<string>',
            ],
        ],
        'FrameworkVersion' => '<string>',
        'Id' => '<string>',
        'Name' => '<string>',
        'Status' => 'CREATING|AVAILABLE|CREATE_FAILED|DELETING|DELETED',
        'Tags' => ['<string>', ...],
        'VotingPolicy' => [
            'ApprovalThresholdPolicy' => [
                'ProposalDurationInHours' => <integer>,
                'ThresholdComparator' => 'GREATER_THAN|GREATER_THAN_OR_EQUAL_TO',
                'ThresholdPercentage' => <integer>,
            ],
        ],
        'VpcEndpointServiceName' => '<string>',
    ],
]

Result Details

Members

Network

Type: Network structure

An object containing network configuration parameters.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

GetNode

$result = $client->getNode([/* ... */]);
$promise = $client->getNodeAsync([/* ... */]);

Returns detailed information about a node.

Applies to Hyperledger Fabric and Ethereum.

Parameter Syntax

$result = $client->getNode([
    'MemberId' => '<string>',
    'NetworkId' => '<string>', // REQUIRED
    'NodeId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MemberId

Type: string

The unique identifier of the member that owns the node.

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

NetworkId

Required: Yes
Type: string

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

NodeId

Required: Yes
Type: string

The unique identifier of the node.

Result Syntax

[
    'Node' => [
        'Arn' => '<string>',
        'AvailabilityZone' => '<string>',
        'CreationDate' => <DateTime>,
        'FrameworkAttributes' => [
            'Ethereum' => [
                'HttpEndpoint' => '<string>',
                'WebSocketEndpoint' => '<string>',
            ],
            'Fabric' => [
                'PeerEndpoint' => '<string>',
                'PeerEventEndpoint' => '<string>',
            ],
        ],
        'Id' => '<string>',
        'InstanceType' => '<string>',
        'KmsKeyArn' => '<string>',
        'LogPublishingConfiguration' => [
            'Fabric' => [
                'ChaincodeLogs' => [
                    'Cloudwatch' => [
                        'Enabled' => true || false,
                    ],
                ],
                'PeerLogs' => [
                    'Cloudwatch' => [
                        'Enabled' => true || false,
                    ],
                ],
            ],
        ],
        'MemberId' => '<string>',
        'NetworkId' => '<string>',
        'StateDB' => 'LevelDB|CouchDB',
        'Status' => 'CREATING|AVAILABLE|UNHEALTHY|CREATE_FAILED|UPDATING|DELETING|DELETED|FAILED|INACCESSIBLE_ENCRYPTION_KEY',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Members

Node

Type: Node structure

Properties of the node configuration.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

GetProposal

$result = $client->getProposal([/* ... */]);
$promise = $client->getProposalAsync([/* ... */]);

Returns detailed information about a proposal.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->getProposal([
    'NetworkId' => '<string>', // REQUIRED
    'ProposalId' => '<string>', // REQUIRED
]);

Parameter Details

Members

NetworkId

Required: Yes
Type: string

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

ProposalId

Required: Yes
Type: string

The unique identifier of the proposal.

Result Syntax

[
    'Proposal' => [
        'Actions' => [
            'Invitations' => [
                [
                    'Principal' => '<string>',
                ],
                // ...
            ],
            'Removals' => [
                [
                    'MemberId' => '<string>',
                ],
                // ...
            ],
        ],
        'Arn' => '<string>',
        'CreationDate' => <DateTime>,
        'Description' => '<string>',
        'ExpirationDate' => <DateTime>,
        'NetworkId' => '<string>',
        'NoVoteCount' => <integer>,
        'OutstandingVoteCount' => <integer>,
        'ProposalId' => '<string>',
        'ProposedByMemberId' => '<string>',
        'ProposedByMemberName' => '<string>',
        'Status' => 'IN_PROGRESS|APPROVED|REJECTED|EXPIRED|ACTION_FAILED',
        'Tags' => ['<string>', ...],
        'YesVoteCount' => <integer>,
    ],
]

Result Details

Members

Proposal

Type: Proposal structure

Information about a proposal.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

ListAccessors

$result = $client->listAccessors([/* ... */]);
$promise = $client->listAccessorsAsync([/* ... */]);

Returns a list of the accessors and their properties. Accessor objects are containers that have the information required for token based access to your Ethereum nodes.

Parameter Syntax

$result = $client->listAccessors([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of accessors to list.

NextToken

Type: string

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

Result Syntax

[
    'Accessors' => [
        [
            'Arn' => '<string>',
            'CreationDate' => <DateTime>,
            'Id' => '<string>',
            'Status' => 'AVAILABLE|PENDING_DELETION|DELETED',
            'Type' => 'BILLING_TOKEN',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Accessors

Type: Array of AccessorSummary structures

An array of AccessorSummary objects that contain configuration properties for each accessor.

NextToken

Type: string

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

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

ListInvitations

$result = $client->listInvitations([/* ... */]);
$promise = $client->listInvitationsAsync([/* ... */]);

Returns a list of all invitations for the current Amazon Web Services account.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->listInvitations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of invitations to return.

NextToken

Type: string

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

Result Syntax

[
    'Invitations' => [
        [
            'Arn' => '<string>',
            'CreationDate' => <DateTime>,
            'ExpirationDate' => <DateTime>,
            'InvitationId' => '<string>',
            'NetworkSummary' => [
                'Arn' => '<string>',
                'CreationDate' => <DateTime>,
                'Description' => '<string>',
                'Framework' => 'HYPERLEDGER_FABRIC|ETHEREUM',
                'FrameworkVersion' => '<string>',
                'Id' => '<string>',
                'Name' => '<string>',
                'Status' => 'CREATING|AVAILABLE|CREATE_FAILED|DELETING|DELETED',
            ],
            'Status' => 'PENDING|ACCEPTED|ACCEPTING|REJECTED|EXPIRED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Invitations

Type: Array of Invitation structures

The invitations for the network.

NextToken

Type: string

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

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
ResourceLimitExceededException:
The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

ListMembers

$result = $client->listMembers([/* ... */]);
$promise = $client->listMembersAsync([/* ... */]);

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

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->listMembers([
    'IsOwned' => true || false,
    'MaxResults' => <integer>,
    'Name' => '<string>',
    'NetworkId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'Status' => 'CREATING|AVAILABLE|CREATE_FAILED|UPDATING|DELETING|DELETED|INACCESSIBLE_ENCRYPTION_KEY',
]);

Parameter Details

Members

IsOwned

Type: boolean

An optional Boolean value. If provided, the request is limited either to members that the current Amazon Web Services account owns (true) or that other Amazon Web Services accountsn own (false). If omitted, all members are listed.

MaxResults

Type: int

The maximum number of members to return in the request.

Name

Type: string

The optional name of the member to list.

NetworkId

Required: Yes
Type: string

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

NextToken

Type: string

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

Status

Type: string

An optional status specifier. If provided, only members currently in this status are listed.

Result Syntax

[
    'Members' => [
        [
            'Arn' => '<string>',
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'Id' => '<string>',
            'IsOwned' => true || false,
            'Name' => '<string>',
            'Status' => 'CREATING|AVAILABLE|CREATE_FAILED|UPDATING|DELETING|DELETED|INACCESSIBLE_ENCRYPTION_KEY',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Members

Type: Array of MemberSummary structures

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

NextToken

Type: string

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

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

ListNetworks

$result = $client->listNetworks([/* ... */]);
$promise = $client->listNetworksAsync([/* ... */]);

Returns information about the networks in which the current Amazon Web Services account participates.

Applies to Hyperledger Fabric and Ethereum.

Parameter Syntax

$result = $client->listNetworks([
    'Framework' => 'HYPERLEDGER_FABRIC|ETHEREUM',
    'MaxResults' => <integer>,
    'Name' => '<string>',
    'NextToken' => '<string>',
    'Status' => 'CREATING|AVAILABLE|CREATE_FAILED|DELETING|DELETED',
]);

Parameter Details

Members

Framework

Type: string

An optional framework specifier. If provided, only networks of this framework type are listed.

MaxResults

Type: int

The maximum number of networks to list.

Name

Type: string

The name of the network.

NextToken

Type: string

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

Status

Type: string

An optional status specifier. If provided, only networks currently in this status are listed.

Applies only to Hyperledger Fabric.

Result Syntax

[
    'Networks' => [
        [
            'Arn' => '<string>',
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'Framework' => 'HYPERLEDGER_FABRIC|ETHEREUM',
            'FrameworkVersion' => '<string>',
            'Id' => '<string>',
            'Name' => '<string>',
            'Status' => 'CREATING|AVAILABLE|CREATE_FAILED|DELETING|DELETED',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Networks

Type: Array of NetworkSummary structures

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

NextToken

Type: string

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

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

ListNodes

$result = $client->listNodes([/* ... */]);
$promise = $client->listNodesAsync([/* ... */]);

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

Parameter Syntax

$result = $client->listNodes([
    'MaxResults' => <integer>,
    'MemberId' => '<string>',
    'NetworkId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'Status' => 'CREATING|AVAILABLE|UNHEALTHY|CREATE_FAILED|UPDATING|DELETING|DELETED|FAILED|INACCESSIBLE_ENCRYPTION_KEY',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of nodes to list.

MemberId

Type: string

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

Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

NetworkId

Required: Yes
Type: string

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

NextToken

Type: string

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

Status

Type: string

An optional status specifier. If provided, only nodes currently in this status are listed.

Result Syntax

[
    'NextToken' => '<string>',
    'Nodes' => [
        [
            'Arn' => '<string>',
            'AvailabilityZone' => '<string>',
            'CreationDate' => <DateTime>,
            'Id' => '<string>',
            'InstanceType' => '<string>',
            'Status' => 'CREATING|AVAILABLE|UNHEALTHY|CREATE_FAILED|UPDATING|DELETING|DELETED|FAILED|INACCESSIBLE_ENCRYPTION_KEY',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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

Nodes

Type: Array of NodeSummary structures

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

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

ListProposalVotes

$result = $client->listProposalVotes([/* ... */]);
$promise = $client->listProposalVotesAsync([/* ... */]);

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

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->listProposalVotes([
    'MaxResults' => <integer>,
    'NetworkId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
    'ProposalId' => '<string>', // REQUIRED
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of votes to return.

NetworkId

Required: Yes
Type: string

The unique identifier of the network.

NextToken

Type: string

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

ProposalId

Required: Yes
Type: string

The unique identifier of the proposal.

Result Syntax

[
    'NextToken' => '<string>',
    'ProposalVotes' => [
        [
            'MemberId' => '<string>',
            'MemberName' => '<string>',
            'Vote' => 'YES|NO',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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

ProposalVotes

Type: Array of VoteSummary structures

The list of votes.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

ListProposals

$result = $client->listProposals([/* ... */]);
$promise = $client->listProposalsAsync([/* ... */]);

Returns a list of proposals for the network.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->listProposals([
    'MaxResults' => <integer>,
    'NetworkId' => '<string>', // REQUIRED
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of proposals to return.

NetworkId

Required: Yes
Type: string

The unique identifier of the network.

NextToken

Type: string

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

Result Syntax

[
    'NextToken' => '<string>',
    'Proposals' => [
        [
            'Arn' => '<string>',
            'CreationDate' => <DateTime>,
            'Description' => '<string>',
            'ExpirationDate' => <DateTime>,
            'ProposalId' => '<string>',
            'ProposedByMemberId' => '<string>',
            'ProposedByMemberName' => '<string>',
            'Status' => 'IN_PROGRESS|APPROVED|REJECTED|EXPIRED|ACTION_FAILED',
        ],
        // ...
    ],
]

Result Details

Members

NextToken

Type: string

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

Proposals

Type: Array of ProposalSummary structures

The summary of each proposal made on the network.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns a list of tags for the specified resource. Each tag consists of a key and optional value.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

The tags assigned to the resource.

Errors

InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ResourceNotReadyException:
The requested resource exists but isn't in a status that can complete the operation.

RejectInvitation

$result = $client->rejectInvitation([/* ... */]);
$promise = $client->rejectInvitationAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->rejectInvitation([
    'InvitationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

InvitationId

Required: Yes
Type: string

The unique identifier of the invitation to reject.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
IllegalActionException:
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource. Each tag consists of a key and optional value.

When you specify a tag key that already exists, the tag value is overwritten with the new value. Use UntagResource to remove tag keys.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags to assign to the specified resource. Tag values can be empty, for example, "MyTagKey" : "". You can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
TooManyTagsException:
ResourceNotReadyException:
The requested resource exists but isn't in a status that can complete the operation.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the specified tags from the Amazon Managed Blockchain resource.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

TagKeys

Required: Yes
Type: Array of strings

The tag keys.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.
InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ResourceNotReadyException:
The requested resource exists but isn't in a status that can complete the operation.

UpdateMember

$result = $client->updateMember([/* ... */]);
$promise = $client->updateMemberAsync([/* ... */]);

Updates a member configuration with new parameters.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->updateMember([
    'LogPublishingConfiguration' => [
        'Fabric' => [
            'CaLogs' => [
                'Cloudwatch' => [
                    'Enabled' => true || false,
                ],
            ],
        ],
    ],
    'MemberId' => '<string>', // REQUIRED
    'NetworkId' => '<string>', // REQUIRED
]);

Parameter Details

Members

LogPublishingConfiguration

Type: MemberLogPublishingConfiguration structure

Configuration properties for publishing to Amazon CloudWatch Logs.

MemberId

Required: Yes
Type: string

The unique identifier of the member.

NetworkId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

UpdateNode

$result = $client->updateNode([/* ... */]);
$promise = $client->updateNodeAsync([/* ... */]);

Updates a node configuration with new parameters.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->updateNode([
    'LogPublishingConfiguration' => [
        'Fabric' => [
            'ChaincodeLogs' => [
                'Cloudwatch' => [
                    'Enabled' => true || false,
                ],
            ],
            'PeerLogs' => [
                'Cloudwatch' => [
                    'Enabled' => true || false,
                ],
            ],
        ],
    ],
    'MemberId' => '<string>',
    'NetworkId' => '<string>', // REQUIRED
    'NodeId' => '<string>', // REQUIRED
]);

Parameter Details

Members

LogPublishingConfiguration

Type: NodeLogPublishingConfiguration structure

Configuration properties for publishing to Amazon CloudWatch Logs.

MemberId

Type: string

The unique identifier of the member that owns the node.

Applies only to Hyperledger Fabric.

NetworkId

Required: Yes
Type: string

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

NodeId

Required: Yes
Type: string

The unique identifier of the node.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

VoteOnProposal

$result = $client->voteOnProposal([/* ... */]);
$promise = $client->voteOnProposalAsync([/* ... */]);

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 Amazon Web Services account as the principal that calls the action.

Applies only to Hyperledger Fabric.

Parameter Syntax

$result = $client->voteOnProposal([
    'NetworkId' => '<string>', // REQUIRED
    'ProposalId' => '<string>', // REQUIRED
    'Vote' => 'YES|NO', // REQUIRED
    'VoterMemberId' => '<string>', // REQUIRED
]);

Parameter Details

Members

NetworkId

Required: Yes
Type: string

The unique identifier of the network.

ProposalId

Required: Yes
Type: string

The unique identifier of the proposal.

Vote

Required: Yes
Type: string

The value of the vote.

VoterMemberId

Required: Yes
Type: string

The unique identifier of the member casting the vote.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

InvalidRequestException:
The action or operation requested is invalid. Verify that the action is typed correctly.
IllegalActionException:
AccessDeniedException:
You don't have sufficient access to perform this action.
ResourceNotFoundException:
A requested resource doesn't exist. It may have been deleted or referenced incorrectly.
ThrottlingException:
The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.
InternalServiceErrorException:
The request processing has failed because of an unknown error, exception or failure.

Shapes

AccessDeniedException

Description

You don't have sufficient access to perform this action.

Members

Message

Type: string

Accessor

Description

The properties of the Accessor.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

BillingToken

Type: string

The billing token is a property of the accessor. Use this token to make Ethereum API calls to your Ethereum node. The billing token is used to track your accessor object for billing Ethereum API requests made to your Ethereum nodes.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time of the accessor.

Id

Type: string

The unique identifier of the accessor.

Status

Type: string

The current status of the accessor.

Type

Type: string

The type of the accessor.

Currently accessor type is restricted to BILLING_TOKEN.

AccessorSummary

Description

A summary of accessor properties.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The creation date and time of the accessor.

Id

Type: string

The unique identifier of the accessor.

Status

Type: string

The current status of the accessor.

Type

Type: string

The type of the accessor.

Currently accessor type is restricted to BILLING_TOKEN.

ApprovalThresholdPolicy

Description

A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

Applies only to Hyperledger Fabric.

Members

ProposalDurationInHours

Type: int

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 aren't carried out.

ThresholdComparator

Type: 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.

ThresholdPercentage

Type: int

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.

IllegalActionException

Description

Members

Message

Type: string

InternalServiceErrorException

Description

The request processing has failed because of an unknown error, exception or failure.

Members

InvalidRequestException

Description

The action or operation requested is invalid. Verify that the action is typed correctly.

Members

Message

Type: string

Invitation

Description

An invitation to an Amazon Web Services account to create a member and join the network.

Applies only to Hyperledger Fabric.

Members

Arn

Type: string

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.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the invitation was created.

ExpirationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

InvitationId

Type: string

The unique identifier for the invitation.

NetworkSummary

Type: NetworkSummary structure

A summary of network configuration properties.

Status

Type: string

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.

InviteAction

Description

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

Applies only to Hyperledger Fabric.

Members

Principal

Required: Yes
Type: string

The Amazon Web Services account ID to invite.

LogConfiguration

Description

A configuration for logging events.

Members

Enabled

Type: boolean

Indicates whether logging is enabled.

LogConfigurations

Description

A collection of log configurations.

Members

Cloudwatch

Type: LogConfiguration structure

Parameters for publishing logs to Amazon CloudWatch Logs.

Member

Description

Member configuration properties.

Applies only to Hyperledger Fabric.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the member was created.

Description

Type: string

An optional description for the member.

FrameworkAttributes

Type: MemberFrameworkAttributes structure

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

Id

Type: string

The unique identifier of the member.

KmsKeyArn

Type: string

The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the member uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the member uses an Amazon Web Services owned KMS key for encryption. This parameter is inherited by the nodes that this member owns.

For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

LogPublishingConfiguration

Type: MemberLogPublishingConfiguration structure

Configuration properties for logging events associated with a member.

Name

Type: string

The name of the member.

NetworkId

Type: string

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

Status

Type: string

The status of a member.

CREATING - The Amazon Web Services account is in the process of creating a member.
AVAILABLE - The member has been created and can participate in the network.
CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.
UPDATING - The member is in the process of being updated.
DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services 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 Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.

The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

MemberConfiguration

Description

Configuration properties of the member.

Applies only to Hyperledger Fabric.

Members

Description

Type: string

An optional description of the member.

FrameworkConfiguration

Required: Yes
Type: MemberFrameworkConfiguration structure

Configuration properties of the blockchain framework relevant to the member.

KmsKeyArn

Type: string

The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) to use for encryption at rest in the member. This parameter is inherited by any nodes that this member creates. For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

Use one of the following options to specify this parameter:

Undefined or empty string - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf.
A valid symmetric customer managed KMS key - Use the specified KMS key in your account that you create, own, and manage.

Amazon Managed Blockchain doesn't support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.

The following is an example of a KMS key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

LogPublishingConfiguration

Type: MemberLogPublishingConfiguration structure

Configuration properties for logging events associated with a member of a Managed Blockchain network.

Name

Required: Yes
Type: string

The name of the member.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

MemberFabricAttributes

Description

Attributes of Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.

Members

AdminUsername

Type: string

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

CaEndpoint

Type: string

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

MemberFabricConfiguration

Description

Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.

Members

AdminPassword

Required: Yes
Type: string

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 quotation mark (‘), a double quotation marks (“), a forward slash(/), a backward slash(\), @, or a space.

AdminUsername

Required: Yes
Type: string

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

MemberFabricLogPublishingConfiguration

Description

Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.

Members

CaLogs

Type: LogConfigurations structure

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.

MemberFrameworkAttributes

Description

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

Members

Fabric

Type: MemberFabricAttributes structure

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

MemberFrameworkConfiguration

Description

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

Members

Fabric

Type: MemberFabricConfiguration structure

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

MemberLogPublishingConfiguration

Description

Configuration properties for logging events associated with a member of a Managed Blockchain network.

Members

Fabric

Type: MemberFabricLogPublishingConfiguration structure

Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.

MemberSummary

Description

A summary of configuration properties for a member.

Applies only to Hyperledger Fabric.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the member was created.

Description

Type: string

An optional description of the member.

Id

Type: string

The unique identifier of the member.

IsOwned

Type: boolean

An indicator of whether the member is owned by your Amazon Web Services account or a different Amazon Web Services account.

Name

Type: string

The name of the member.

Status

Type: string

The status of the member.

CREATING - The Amazon Web Services account is in the process of creating a member.
AVAILABLE - The member has been created and can participate in the network.
CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.
UPDATING - The member is in the process of being updated.
DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services 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 Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in Key Management Service (KMS) for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.

The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

Network

Description

Network configuration properties.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the network was created.

Description

Type: string

Attributes of the blockchain framework for the network.

Framework

Type: string

The blockchain framework that the network uses.

FrameworkAttributes

Type: NetworkFrameworkAttributes structure

Attributes of the blockchain framework that the network uses.

FrameworkVersion

Type: string

The version of the blockchain framework that the network uses.

Id

Type: string

The unique identifier of the network.

Name

Type: string

The name of the network.

Status

Type: string

The current status of the network.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags assigned to the network. Each tag consists of a key and optional value.

VotingPolicy

Type: VotingPolicy structure

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

VpcEndpointServiceName

Type: 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.

NetworkEthereumAttributes

Description

Attributes of Ethereum for a network.

Members

ChainId

Type: string

The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:

mainnet = 1
goerli = 5
rinkeby = 4
ropsten = 3

NetworkFabricAttributes

Description

Attributes of Hyperledger Fabric for a network.

Members

Edition

Type: string

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

OrderingServiceEndpoint

Type: string

The endpoint of the ordering service for the network.

NetworkFabricConfiguration

Description

Hyperledger Fabric configuration properties for the network.

Members

Edition

Required: Yes
Type: string

The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.

NetworkFrameworkAttributes

Description

Attributes relevant to the network for the blockchain framework that the network uses.

Members

Ethereum

Type: NetworkEthereumAttributes structure

Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network.

Fabric

Type: NetworkFabricAttributes structure

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

NetworkFrameworkConfiguration

Description

Configuration properties relevant to the network for the blockchain framework that the network uses.

Members

Fabric

Type: NetworkFabricConfiguration structure

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

NetworkSummary

Description

A summary of network configuration properties.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the network was created.

Description

Type: string

An optional description of the network.

Framework

Type: string

The blockchain framework that the network uses.

FrameworkVersion

Type: string

The version of the blockchain framework that the network uses.

Id

Type: string

The unique identifier of the network.

Name

Type: string

The name of the network.

Status

Type: string

The current status of the network.

Node

Description

Configuration properties of a node.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

AvailabilityZone

Type: string

The Availability Zone in which the node exists. Required for Ethereum nodes.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the node was created.

FrameworkAttributes

Type: NodeFrameworkAttributes structure

Attributes of the blockchain framework being used.

Id

Type: string

The unique identifier of the node.

InstanceType

Type: string

The instance type of the node.

KmsKeyArn

Type: string

The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the node uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the node uses an Amazon Web Services owned KMS key for encryption. The node inherits this parameter from the member that it belongs to.

For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

Applies only to Hyperledger Fabric.

LogPublishingConfiguration

Type: NodeLogPublishingConfiguration structure

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

MemberId

Type: string

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

Applies only to Hyperledger Fabric.

NetworkId

Type: string

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

StateDB

Type: string

The state database that the node uses. Values are LevelDB or CouchDB.

Applies only to Hyperledger Fabric.

Status

Type: string

The status of the node.

CREATING - The Amazon Web Services account is in the process of creating a node.
AVAILABLE - The node has been created and can participate in the network.
UNHEALTHY - The node is impaired and might not function as expected. Amazon Managed Blockchain automatically finds nodes in this state and tries to recover them. If a node is recoverable, it returns to AVAILABLE. Otherwise, it moves to FAILED status.
CREATE_FAILED - The Amazon Web Services account attempted to create a node and creation failed.
UPDATING - The node is in the process of being updated.
DELETING - The node is in the process of being deleted.
DELETED - The node can no longer participate on the network.
FAILED - The node is no longer functional, cannot be recovered, and must be deleted.
INACCESSIBLE_ENCRYPTION_KEY - The node is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.

The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the node resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags assigned to the node. Each tag consists of a key and optional value.

NodeConfiguration

Description

Configuration properties of a node.

Members

AvailabilityZone

Type: string

The Availability Zone in which the node exists. Required for Ethereum nodes.

InstanceType

Required: Yes
Type: string

The Amazon Managed Blockchain instance type for the node.

LogPublishingConfiguration

Type: NodeLogPublishingConfiguration structure

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

StateDB

Type: string

The state database that the node uses. Values are LevelDB or CouchDB. When using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or later, the default is CouchDB.

Applies only to Hyperledger Fabric.

NodeEthereumAttributes

Description

Attributes of an Ethereum node.

Members

HttpEndpoint

Type: string

The endpoint on which the Ethereum node listens to run Ethereum API methods over HTTP connections from a client. Use this endpoint in client code for smart contracts when using an HTTP connection. Connections to this endpoint are authenticated using Signature Version 4.

WebSocketEndpoint

Type: string

The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over WebSocket connections from a client. Use this endpoint in client code for smart contracts when using a WebSocket connection. Connections to this endpoint are authenticated using Signature Version 4.

NodeFabricAttributes

Description

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

Members

PeerEndpoint

Type: string

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

PeerEventEndpoint

Type: string

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

NodeFabricLogPublishingConfiguration

Description

Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.

Members

ChaincodeLogs

Type: LogConfigurations structure

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.

PeerLogs

Type: LogConfigurations structure

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.

NodeFrameworkAttributes

Description

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

Members

Ethereum

Type: NodeEthereumAttributes structure

Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum.

Fabric

Type: NodeFabricAttributes structure

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

NodeLogPublishingConfiguration

Description

Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

Members

Fabric

Type: NodeFabricLogPublishingConfiguration structure

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.

NodeSummary

Description

A summary of configuration properties for a node.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

AvailabilityZone

Type: string

The Availability Zone in which the node exists.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the node was created.

Id

Type: string

The unique identifier of the node.

InstanceType

Type: string

The EC2 instance type for the node.

Status

Type: string

The status of the node.

Proposal

Description

Properties of a proposal on a Managed Blockchain network.

Applies only to Hyperledger Fabric.

Members

Actions

Type: ProposalActions structure

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

Arn

Type: string

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the proposal was created.

Description

Type: string

The description of the proposal.

ExpirationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

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 haven't cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions aren't carried out.

NetworkId

Type: string

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

NoVoteCount

Type: int

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

OutstandingVoteCount

Type: int

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.

ProposalId

Type: string

The unique identifier of the proposal.

ProposedByMemberId

Type: string

The unique identifier of the member that created the proposal.

ProposedByMemberName

Type: string

The name of the member that created the proposal.

Status

Type: 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 aren't carried out.
EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.
ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.

Tags

Type: Associative array of custom strings keys (TagKey) to strings

Tags assigned to the proposal. Each tag consists of a key and optional value.

YesVoteCount

Type: int

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

ProposalActions

Description

The actions to carry out if a proposal is APPROVED.

Applies only to Hyperledger Fabric.

Members

Invitations

Type: Array of InviteAction structures

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

Removals

Type: Array of RemoveAction structures

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.

ProposalSummary

Description

Properties of a proposal.

Applies only to Hyperledger Fabric.

Members

Arn

Type: string

The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CreationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

The date and time that the proposal was created.

Description

Type: string

The description of the proposal.

ExpirationDate

Type: timestamp (string|DateTime or anything parsable by strtotime)

ProposalId

Type: string

The unique identifier of the proposal.

ProposedByMemberId

Type: string

The unique identifier of the member that created the proposal.

ProposedByMemberName

Type: string

The name of the member that created the proposal.

Status

Type: 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 aren't carried out.
EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.
ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error.

RemoveAction

Description

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.

Applies only to Hyperledger Fabric.

Members

MemberId

Required: Yes
Type: string

The unique identifier of the member to remove.

ResourceAlreadyExistsException

Description

A resource request is issued for a resource that already exists.

Members

Message

Type: string

ResourceLimitExceededException

Description

The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.

Members

Message

Type: string

ResourceNotFoundException

Description

A requested resource doesn't exist. It may have been deleted or referenced incorrectly.

Members

Message

Type: string

ResourceName

Type: string

A requested resource doesn't exist. It may have been deleted or referenced inaccurately.

ResourceNotReadyException

Description

The requested resource exists but isn't in a status that can complete the operation.

Members

Message

Type: string

ThrottlingException

Description

The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.

Members

TooManyTagsException

Description

Members

Message

Type: string

ResourceName

Type: string

VoteSummary

Description

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

Applies only to Hyperledger Fabric.

Members

MemberId

Type: string

The unique identifier of the member that cast the vote.

MemberName

Type: string

The name of the member that cast the vote.

Vote

Type: string

The vote value, either YES or NO.

VotingPolicy

Description

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

Applies only to Hyperledger Fabric.

Members

ApprovalThresholdPolicy

Type: ApprovalThresholdPolicy structure

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.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Managed Blockchain 2018-09-24

Operation Summary

Paginators

Operations

CreateAccessor

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMember

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateNetwork

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateNode

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateProposal

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteAccessor

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteMember

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteNode

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

GetAccessor

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

GetMember