CreateAccessor

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

Creates a new accessor for use with Amazon Managed Blockchain service that supports token based access. The accessor contains information required for token based access.

Parameter Syntax

$result = $client->createAccessor([
    'AccessorType' => 'BILLING_TOKEN', // REQUIRED
    'ClientRequestToken' => '<string>', // REQUIRED
    'NetworkType' => 'ETHEREUM_GOERLI|ETHEREUM_MAINNET|ETHEREUM_MAINNET_AND_GOERLI|POLYGON_MAINNET|POLYGON_MUMBAI',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'AccessorId' => '<string>',
    'BillingToken' => '<string>',
    'NetworkType' => 'ETHEREUM_GOERLI|ETHEREUM_MAINNET|ETHEREUM_MAINNET_AND_GOERLI|POLYGON_MAINNET|POLYGON_MUMBAI',
]

Result Details

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:

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[
    'Accessor' => [
        'Arn' => '<string>',
        'BillingToken' => '<string>',
        'CreationDate' => <DateTime>,
        'Id' => '<string>',
        'NetworkType' => 'ETHEREUM_GOERLI|ETHEREUM_MAINNET|ETHEREUM_MAINNET_AND_GOERLI|POLYGON_MAINNET|POLYGON_MUMBAI',
        'Status' => 'AVAILABLE|PENDING_DELETION|DELETED',
        'Tags' => ['<string>', ...],
        'Type' => 'BILLING_TOKEN',
    ],
]

Result Details

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

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

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

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

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

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

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

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

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>,
    'NetworkType' => 'ETHEREUM_GOERLI|ETHEREUM_MAINNET|ETHEREUM_MAINNET_AND_GOERLI|POLYGON_MAINNET|POLYGON_MUMBAI',
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Accessors' => [
        [
            'Arn' => '<string>',
            'CreationDate' => <DateTime>,
            'Id' => '<string>',
            'NetworkType' => 'ETHEREUM_GOERLI|ETHEREUM_MAINNET|ETHEREUM_MAINNET_AND_GOERLI|POLYGON_MAINNET|POLYGON_MUMBAI',
            'Status' => 'AVAILABLE|PENDING_DELETION|DELETED',
            'Type' => 'BILLING_TOKEN',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

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

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

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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

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

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.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

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.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.