ManagedBlockchainClient

Index > ManagedBlockchain > ManagedBlockchainClient

Auto-generated documentation for ManagedBlockchain type annotations stubs module mypy-boto3-managedblockchain.

ManagedBlockchainClient

Type annotations and code completion for boto3.client("managedblockchain"). boto3 documentation

# ManagedBlockchainClient usage example

from boto3.session import Session
from mypy_boto3_managedblockchain.client import ManagedBlockchainClient

def get_managedblockchain_client() -> ManagedBlockchainClient:
    return Session().client("managedblockchain")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("managedblockchain").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("managedblockchain")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.IllegalActionException,
    client.exceptions.InternalServiceErrorException,
    client.exceptions.InvalidRequestException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceLimitExceededException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceNotReadyException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_managedblockchain.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("managedblockchain").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("managedblockchain").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_accessor

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

Type annotations and code completion for boto3.client("managedblockchain").create_accessor method. boto3 documentation

# create_accessor method definition

def create_accessor(
    self,
    *,
    ClientRequestToken: str,
    AccessorType: AccessorTypeType,  # (1)
    Tags: Mapping[str, str] = ...,
    NetworkType: AccessorNetworkTypeType = ...,  # (2)
) -> CreateAccessorOutputTypeDef:  # (3)
    ...

1. See AccessorTypeType
2. See AccessorNetworkTypeType
3. See CreateAccessorOutputTypeDef

# create_accessor method usage example with argument unpacking

kwargs: CreateAccessorInputRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
    "AccessorType": ...,
}

parent.create_accessor(**kwargs)

1. See CreateAccessorInputRequestTypeDef

create_member

Creates a member within a Managed Blockchain network.

Type annotations and code completion for boto3.client("managedblockchain").create_member method. boto3 documentation

# create_member method definition

def create_member(
    self,
    *,
    ClientRequestToken: str,
    InvitationId: str,
    NetworkId: str,
    MemberConfiguration: MemberConfigurationTypeDef,  # (1)
) -> CreateMemberOutputTypeDef:  # (2)
    ...

1. See MemberConfigurationTypeDef
2. See CreateMemberOutputTypeDef

# create_member method usage example with argument unpacking

kwargs: CreateMemberInputRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
    "InvitationId": ...,
    "NetworkId": ...,
    "MemberConfiguration": ...,
}

parent.create_member(**kwargs)

1. See CreateMemberInputRequestTypeDef

create_network

Creates a new blockchain network using Amazon Managed Blockchain.

Type annotations and code completion for boto3.client("managedblockchain").create_network method. boto3 documentation

# create_network method definition

def create_network(
    self,
    *,
    ClientRequestToken: str,
    Name: str,
    Framework: FrameworkType,  # (1)
    FrameworkVersion: str,
    VotingPolicy: VotingPolicyTypeDef,  # (2)
    MemberConfiguration: MemberConfigurationTypeDef,  # (3)
    Description: str = ...,
    FrameworkConfiguration: NetworkFrameworkConfigurationTypeDef = ...,  # (4)
    Tags: Mapping[str, str] = ...,
) -> CreateNetworkOutputTypeDef:  # (5)
    ...

1. See FrameworkType
2. See VotingPolicyTypeDef
3. See MemberConfigurationTypeDef
4. See NetworkFrameworkConfigurationTypeDef
5. See CreateNetworkOutputTypeDef

# create_network method usage example with argument unpacking

kwargs: CreateNetworkInputRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
    "Name": ...,
    "Framework": ...,
    "FrameworkVersion": ...,
    "VotingPolicy": ...,
    "MemberConfiguration": ...,
}

parent.create_network(**kwargs)

1. See CreateNetworkInputRequestTypeDef

create_node

Creates a node on the specified blockchain network.

Type annotations and code completion for boto3.client("managedblockchain").create_node method. boto3 documentation

# create_node method definition

def create_node(
    self,
    *,
    ClientRequestToken: str,
    NetworkId: str,
    NodeConfiguration: NodeConfigurationTypeDef,  # (1)
    MemberId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateNodeOutputTypeDef:  # (2)
    ...

1. See NodeConfigurationTypeDef
2. See CreateNodeOutputTypeDef

# create_node method usage example with argument unpacking

kwargs: CreateNodeInputRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
    "NetworkId": ...,
    "NodeConfiguration": ...,
}

parent.create_node(**kwargs)

1. See CreateNodeInputRequestTypeDef

create_proposal

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.

Type annotations and code completion for boto3.client("managedblockchain").create_proposal method. boto3 documentation

# create_proposal method definition

def create_proposal(
    self,
    *,
    ClientRequestToken: str,
    NetworkId: str,
    MemberId: str,
    Actions: ProposalActionsTypeDef,  # (1)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateProposalOutputTypeDef:  # (2)
    ...

1. See ProposalActionsTypeDef
2. See CreateProposalOutputTypeDef

# create_proposal method usage example with argument unpacking

kwargs: CreateProposalInputRequestTypeDef = {  # (1)
    "ClientRequestToken": ...,
    "NetworkId": ...,
    "MemberId": ...,
    "Actions": ...,
}

parent.create_proposal(**kwargs)

1. See CreateProposalInputRequestTypeDef

delete_accessor

Deletes an accessor that your Amazon Web Services account owns.

Type annotations and code completion for boto3.client("managedblockchain").delete_accessor method. boto3 documentation

# delete_accessor method definition

def delete_accessor(
    self,
    *,
    AccessorId: str,
) -> Dict[str, Any]:
    ...

# delete_accessor method usage example with argument unpacking

kwargs: DeleteAccessorInputRequestTypeDef = {  # (1)
    "AccessorId": ...,
}

parent.delete_accessor(**kwargs)

1. See DeleteAccessorInputRequestTypeDef

delete_member

Deletes a member.

Type annotations and code completion for boto3.client("managedblockchain").delete_member method. boto3 documentation

# delete_member method definition

def delete_member(
    self,
    *,
    NetworkId: str,
    MemberId: str,
) -> Dict[str, Any]:
    ...

# delete_member method usage example with argument unpacking

kwargs: DeleteMemberInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "MemberId": ...,
}

parent.delete_member(**kwargs)

1. See DeleteMemberInputRequestTypeDef

delete_node

Deletes a node that your Amazon Web Services account owns.

Type annotations and code completion for boto3.client("managedblockchain").delete_node method. boto3 documentation

# delete_node method definition

def delete_node(
    self,
    *,
    NetworkId: str,
    NodeId: str,
    MemberId: str = ...,
) -> Dict[str, Any]:
    ...

# delete_node method usage example with argument unpacking

kwargs: DeleteNodeInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "NodeId": ...,
}

parent.delete_node(**kwargs)

1. See DeleteNodeInputRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("managedblockchain").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_accessor

Returns detailed information about an accessor.

Type annotations and code completion for boto3.client("managedblockchain").get_accessor method. boto3 documentation

# get_accessor method definition

def get_accessor(
    self,
    *,
    AccessorId: str,
) -> GetAccessorOutputTypeDef:  # (1)
    ...

1. See GetAccessorOutputTypeDef

# get_accessor method usage example with argument unpacking

kwargs: GetAccessorInputRequestTypeDef = {  # (1)
    "AccessorId": ...,
}

parent.get_accessor(**kwargs)

1. See GetAccessorInputRequestTypeDef

get_member

Returns detailed information about a member.

Type annotations and code completion for boto3.client("managedblockchain").get_member method. boto3 documentation

# get_member method definition

def get_member(
    self,
    *,
    NetworkId: str,
    MemberId: str,
) -> GetMemberOutputTypeDef:  # (1)
    ...

1. See GetMemberOutputTypeDef

# get_member method usage example with argument unpacking

kwargs: GetMemberInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "MemberId": ...,
}

parent.get_member(**kwargs)

1. See GetMemberInputRequestTypeDef

get_network

Returns detailed information about a network.

Type annotations and code completion for boto3.client("managedblockchain").get_network method. boto3 documentation

# get_network method definition

def get_network(
    self,
    *,
    NetworkId: str,
) -> GetNetworkOutputTypeDef:  # (1)
    ...

1. See GetNetworkOutputTypeDef

# get_network method usage example with argument unpacking

kwargs: GetNetworkInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
}

parent.get_network(**kwargs)

1. See GetNetworkInputRequestTypeDef

get_node

Returns detailed information about a node.

Type annotations and code completion for boto3.client("managedblockchain").get_node method. boto3 documentation

# get_node method definition

def get_node(
    self,
    *,
    NetworkId: str,
    NodeId: str,
    MemberId: str = ...,
) -> GetNodeOutputTypeDef:  # (1)
    ...

1. See GetNodeOutputTypeDef

# get_node method usage example with argument unpacking

kwargs: GetNodeInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "NodeId": ...,
}

parent.get_node(**kwargs)

1. See GetNodeInputRequestTypeDef

get_proposal

Returns detailed information about a proposal.

Type annotations and code completion for boto3.client("managedblockchain").get_proposal method. boto3 documentation

# get_proposal method definition

def get_proposal(
    self,
    *,
    NetworkId: str,
    ProposalId: str,
) -> GetProposalOutputTypeDef:  # (1)
    ...

1. See GetProposalOutputTypeDef

# get_proposal method usage example with argument unpacking

kwargs: GetProposalInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "ProposalId": ...,
}

parent.get_proposal(**kwargs)

1. See GetProposalInputRequestTypeDef

list_accessors

Returns a list of the accessors and their properties.

Type annotations and code completion for boto3.client("managedblockchain").list_accessors method. boto3 documentation

# list_accessors method definition

def list_accessors(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    NetworkType: AccessorNetworkTypeType = ...,  # (1)
) -> ListAccessorsOutputTypeDef:  # (2)
    ...

1. See AccessorNetworkTypeType
2. See ListAccessorsOutputTypeDef

# list_accessors method usage example with argument unpacking

kwargs: ListAccessorsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_accessors(**kwargs)

1. See ListAccessorsInputRequestTypeDef

list_invitations

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

Type annotations and code completion for boto3.client("managedblockchain").list_invitations method. boto3 documentation

# list_invitations method definition

def list_invitations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInvitationsOutputTypeDef:  # (1)
    ...

1. See ListInvitationsOutputTypeDef

# list_invitations method usage example with argument unpacking

kwargs: ListInvitationsInputRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_invitations(**kwargs)

1. See ListInvitationsInputRequestTypeDef

list_members

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

Type annotations and code completion for boto3.client("managedblockchain").list_members method. boto3 documentation

# list_members method definition

def list_members(
    self,
    *,
    NetworkId: str,
    Name: str = ...,
    Status: MemberStatusType = ...,  # (1)
    IsOwned: bool = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMembersOutputTypeDef:  # (2)
    ...

1. See MemberStatusType
2. See ListMembersOutputTypeDef

# list_members method usage example with argument unpacking

kwargs: ListMembersInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
}

parent.list_members(**kwargs)

1. See ListMembersInputRequestTypeDef

list_networks

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

Type annotations and code completion for boto3.client("managedblockchain").list_networks method. boto3 documentation

# list_networks method definition

def list_networks(
    self,
    *,
    Name: str = ...,
    Framework: FrameworkType = ...,  # (1)
    Status: NetworkStatusType = ...,  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListNetworksOutputTypeDef:  # (3)
    ...

1. See FrameworkType
2. See NetworkStatusType
3. See ListNetworksOutputTypeDef

# list_networks method usage example with argument unpacking

kwargs: ListNetworksInputRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.list_networks(**kwargs)

1. See ListNetworksInputRequestTypeDef

list_nodes

Returns information about the nodes within a network.

Type annotations and code completion for boto3.client("managedblockchain").list_nodes method. boto3 documentation

# list_nodes method definition

def list_nodes(
    self,
    *,
    NetworkId: str,
    MemberId: str = ...,
    Status: NodeStatusType = ...,  # (1)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListNodesOutputTypeDef:  # (2)
    ...

1. See NodeStatusType
2. See ListNodesOutputTypeDef

# list_nodes method usage example with argument unpacking

kwargs: ListNodesInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
}

parent.list_nodes(**kwargs)

1. See ListNodesInputRequestTypeDef

list_proposal_votes

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.

Type annotations and code completion for boto3.client("managedblockchain").list_proposal_votes method. boto3 documentation

# list_proposal_votes method definition

def list_proposal_votes(
    self,
    *,
    NetworkId: str,
    ProposalId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListProposalVotesOutputTypeDef:  # (1)
    ...

1. See ListProposalVotesOutputTypeDef

# list_proposal_votes method usage example with argument unpacking

kwargs: ListProposalVotesInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "ProposalId": ...,
}

parent.list_proposal_votes(**kwargs)

1. See ListProposalVotesInputRequestTypeDef

list_proposals

Returns a list of proposals for the network.

Type annotations and code completion for boto3.client("managedblockchain").list_proposals method. boto3 documentation

# list_proposals method definition

def list_proposals(
    self,
    *,
    NetworkId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListProposalsOutputTypeDef:  # (1)
    ...

1. See ListProposalsOutputTypeDef

# list_proposals method usage example with argument unpacking

kwargs: ListProposalsInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
}

parent.list_proposals(**kwargs)

1. See ListProposalsInputRequestTypeDef

list_tags_for_resource

Returns a list of tags for the specified resource.

Type annotations and code completion for boto3.client("managedblockchain").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

reject_invitation

Rejects an invitation to join a network.

Type annotations and code completion for boto3.client("managedblockchain").reject_invitation method. boto3 documentation

# reject_invitation method definition

def reject_invitation(
    self,
    *,
    InvitationId: str,
) -> Dict[str, Any]:
    ...

# reject_invitation method usage example with argument unpacking

kwargs: RejectInvitationInputRequestTypeDef = {  # (1)
    "InvitationId": ...,
}

parent.reject_invitation(**kwargs)

1. See RejectInvitationInputRequestTypeDef

tag_resource

Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource.

Type annotations and code completion for boto3.client("managedblockchain").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes the specified tags from the Amazon Managed Blockchain resource.

Type annotations and code completion for boto3.client("managedblockchain").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_member

Updates a member configuration with new parameters.

Type annotations and code completion for boto3.client("managedblockchain").update_member method. boto3 documentation

# update_member method definition

def update_member(
    self,
    *,
    NetworkId: str,
    MemberId: str,
    LogPublishingConfiguration: MemberLogPublishingConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See MemberLogPublishingConfigurationTypeDef

# update_member method usage example with argument unpacking

kwargs: UpdateMemberInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "MemberId": ...,
}

parent.update_member(**kwargs)

1. See UpdateMemberInputRequestTypeDef

update_node

Updates a node configuration with new parameters.

Type annotations and code completion for boto3.client("managedblockchain").update_node method. boto3 documentation

# update_node method definition

def update_node(
    self,
    *,
    NetworkId: str,
    NodeId: str,
    MemberId: str = ...,
    LogPublishingConfiguration: NodeLogPublishingConfigurationTypeDef = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See NodeLogPublishingConfigurationTypeDef

# update_node method usage example with argument unpacking

kwargs: UpdateNodeInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "NodeId": ...,
}

parent.update_node(**kwargs)

1. See UpdateNodeInputRequestTypeDef

vote_on_proposal

Casts a vote for a specified ProposalId on behalf of a member.

Type annotations and code completion for boto3.client("managedblockchain").vote_on_proposal method. boto3 documentation

# vote_on_proposal method definition

def vote_on_proposal(
    self,
    *,
    NetworkId: str,
    ProposalId: str,
    VoterMemberId: str,
    Vote: VoteValueType,  # (1)
) -> Dict[str, Any]:
    ...

1. See VoteValueType

# vote_on_proposal method usage example with argument unpacking

kwargs: VoteOnProposalInputRequestTypeDef = {  # (1)
    "NetworkId": ...,
    "ProposalId": ...,
    "VoterMemberId": ...,
    "Vote": ...,
}

parent.vote_on_proposal(**kwargs)

1. See VoteOnProposalInputRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("managedblockchain").get_paginator method with overloads.

• client.get_paginator("list_accessors") -> ListAccessorsPaginator