Struct aws_sdk_managedblockchain::Client

source · [−]

pub struct Client { /* private fields */ }

Expand description

Client for Amazon Managed Blockchain

Client for invoking operations on Amazon Managed Blockchain. Each operation on Amazon Managed Blockchain is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Examples

Constructing a client and invoking an operation

    // create a shared configuration. This can be used & shared between multiple service clients.
    let shared_config = aws_config::load_from_env().await;
    let client = aws_sdk_managedblockchain::Client::new(&shared_config);
    // invoke an operation
    /* let rsp = client
        .<operation_name>().
        .<param>("some value")
        .send().await; */

Constructing a client with custom configuration

use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_managedblockchain::config::Builder::from(&shared_config)
  .retry_config(RetryConfig::disabled())
  .build();
let client = aws_sdk_managedblockchain::Client::from_conf(config);

Implementations

source

impl Client

source

pub fn with_config(
client: Client<DynConnector, DynMiddleware<DynConnector>>,
conf: Config
) -> Self

Creates a client with the given service configuration.

source

pub fn conf(&self) -> &Config

Returns the client’s configuration.

source

impl Client

source

pub fn create_member(&self) -> CreateMember

Constructs a fluent builder for the CreateMember operation.

The fluent builder is configurable:
- client_request_token(impl Into<String>) / set_client_request_token(Option<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 AWS SDK or the AWS CLI.
- invitation_id(impl Into<String>) / set_invitation_id(Option<String>):
 The unique identifier of the invitation that is sent to the member to join the network.
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network in which the member is created.
- member_configuration(MemberConfiguration) / set_member_configuration(Option<MemberConfiguration>):
 Member configuration parameters.
On success, responds with CreateMemberOutput with field(s):
- member_id(Option<String>):
 The unique identifier of the member.
On failure, responds with SdkError<CreateMemberError>

source

pub fn create_network(&self) -> CreateNetwork

Constructs a fluent builder for the CreateNetwork operation.

The fluent builder is configurable:
- client_request_token(impl Into<String>) / set_client_request_token(Option<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 AWS SDK or the AWS CLI.
- name(impl Into<String>) / set_name(Option<String>):
 The name of the network.
- description(impl Into<String>) / set_description(Option<String>):
 An optional description for the network.
- framework(Framework) / set_framework(Option<Framework>):
 The blockchain framework that the network uses.
- framework_version(impl Into<String>) / set_framework_version(Option<String>):
 The version of the blockchain framework that the network uses.
- framework_configuration(NetworkFrameworkConfiguration) / set_framework_configuration(Option<NetworkFrameworkConfiguration>):
 Configuration properties of the blockchain framework relevant to the network configuration.
- voting_policy(VotingPolicy) / set_voting_policy(Option<VotingPolicy>):
 The voting rules used by the network to determine if a proposal is approved.
- member_configuration(MemberConfiguration) / set_member_configuration(Option<MemberConfiguration>):
 Configuration properties for the first member within the network.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 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.
On success, responds with CreateNetworkOutput with field(s):
- network_id(Option<String>):
 The unique identifier for the network.
- member_id(Option<String>):
 The unique identifier for the first member within the network.
On failure, responds with SdkError<CreateNetworkError>

source

pub fn create_node(&self) -> CreateNode

Constructs a fluent builder for the CreateNode operation.

The fluent builder is configurable:
- client_request_token(impl Into<String>) / set_client_request_token(Option<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 AWS SDK or the AWS CLI.
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network for the node.
 
 Ethereum public networks have the following NetworkIds:
 - n-ethereum-mainnet
 - n-ethereum-rinkeby
 - n-ethereum-ropsten
- member_id(impl Into<String>) / set_member_id(Option<String>):
 The unique identifier of the member that owns this node.
 
 Applies only to Hyperledger Fabric.
- node_configuration(NodeConfiguration) / set_node_configuration(Option<NodeConfiguration>):
 The properties of a node configuration.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 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.
 
 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.
On success, responds with CreateNodeOutput with field(s):
- node_id(Option<String>):
 The unique identifier of the node.
On failure, responds with SdkError<CreateNodeError>

source

pub fn create_proposal(&self) -> CreateProposal

Constructs a fluent builder for the CreateProposal operation.

The fluent builder is configurable:
- client_request_token(impl Into<String>) / set_client_request_token(Option<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 AWS SDK or the AWS CLI.
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network for which the proposal is made.
- member_id(impl Into<String>) / set_member_id(Option<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 AWS account.
- actions(ProposalActions) / set_actions(Option<ProposalActions>):
 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.
- description(impl Into<String>) / set_description(Option<String>):
 A description for the proposal that is visible to voting members, for example, “Proposal to add Example Corp. as member.”
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 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.
 
 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.
On success, responds with CreateProposalOutput with field(s):
- proposal_id(Option<String>):
 The unique identifier of the proposal.
On failure, responds with SdkError<CreateProposalError>

source

pub fn delete_member(&self) -> DeleteMember

Constructs a fluent builder for the DeleteMember operation.

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network from which the member is removed.
- member_id(impl Into<String>) / set_member_id(Option<String>):
 The unique identifier of the member to remove.
On success, responds with DeleteMemberOutput
On failure, responds with SdkError<DeleteMemberError>

source

pub fn delete_node(&self) -> DeleteNode

Constructs a fluent builder for the DeleteNode operation.

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network that the node is on.
 
 Ethereum public networks have the following NetworkIds:
 - n-ethereum-mainnet
 - n-ethereum-rinkeby
 - n-ethereum-ropsten
- member_id(impl Into<String>) / set_member_id(Option<String>):
 The unique identifier of the member that owns this node.
 
 Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
- node_id(impl Into<String>) / set_node_id(Option<String>):
 The unique identifier of the node.
On success, responds with DeleteNodeOutput
On failure, responds with SdkError<DeleteNodeError>

source

pub fn get_member(&self) -> GetMember

Constructs a fluent builder for the GetMember operation.

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network to which the member belongs.
- member_id(impl Into<String>) / set_member_id(Option<String>):
 The unique identifier of the member.
On success, responds with GetMemberOutput with field(s):
- member(Option<Member>):
 The properties of a member.
On failure, responds with SdkError<GetMemberError>

source

pub fn get_network(&self) -> GetNetwork

Constructs a fluent builder for the GetNetwork operation.

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network to get information about.
On success, responds with GetNetworkOutput with field(s):
- network(Option<Network>):
 An object containing network configuration parameters.
On failure, responds with SdkError<GetNetworkError>

source

pub fn get_node(&self) -> GetNode

Constructs a fluent builder for the GetNode operation.

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network that the node is on.
- member_id(impl Into<String>) / set_member_id(Option<String>):
 The unique identifier of the member that owns the node.
 
 Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
- node_id(impl Into<String>) / set_node_id(Option<String>):
 The unique identifier of the node.
On success, responds with GetNodeOutput with field(s):
- node(Option<Node>):
 Properties of the node configuration.
On failure, responds with SdkError<GetNodeError>

source

pub fn get_proposal(&self) -> GetProposal

Constructs a fluent builder for the GetProposal operation.

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network for which the proposal is made.
- proposal_id(impl Into<String>) / set_proposal_id(Option<String>):
 The unique identifier of the proposal.
On success, responds with GetProposalOutput with field(s):
- proposal(Option<Proposal>):
 Information about a proposal.
On failure, responds with SdkError<GetProposalError>

source

pub fn list_invitations(&self) -> ListInvitations

Constructs a fluent builder for the ListInvitations operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of invitations to return.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On success, responds with ListInvitationsOutput with field(s):
- invitations(Option<Vec<Invitation>>):
 The invitations for the network.
- next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On failure, responds with SdkError<ListInvitationsError>

source

pub fn list_members(&self) -> ListMembers

Constructs a fluent builder for the ListMembers operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network for which to list members.
- name(impl Into<String>) / set_name(Option<String>):
 The optional name of the member to list.
- status(MemberStatus) / set_status(Option<MemberStatus>):
 An optional status specifier. If provided, only members currently in this status are listed.
- is_owned(bool) / set_is_owned(Option<bool>):
 An optional Boolean value. If provided, the request is limited either to members that the current AWS account owns (true) or that other AWS accounts own (false). If omitted, all members are listed.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of members to return in the request.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On success, responds with ListMembersOutput with field(s):
- members(Option<Vec<MemberSummary>>):
 An array of MemberSummary objects. Each object contains details about a network member.
- next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On failure, responds with SdkError<ListMembersError>

source

pub fn list_networks(&self) -> ListNetworks

Constructs a fluent builder for the ListNetworks operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- name(impl Into<String>) / set_name(Option<String>):
 The name of the network.
- framework(Framework) / set_framework(Option<Framework>):
 An optional framework specifier. If provided, only networks of this framework type are listed.
- status(NetworkStatus) / set_status(Option<NetworkStatus>):
 An optional status specifier. If provided, only networks currently in this status are listed.
 
 Applies only to Hyperledger Fabric.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of networks to list.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On success, responds with ListNetworksOutput with field(s):
- networks(Option<Vec<NetworkSummary>>):
 An array of NetworkSummary objects that contain configuration properties for each network.
- next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On failure, responds with SdkError<ListNetworksError>

source

pub fn list_nodes(&self) -> ListNodes

Constructs a fluent builder for the ListNodes operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network for which to list nodes.
- member_id(impl Into<String>) / set_member_id(Option<String>):
 The unique identifier of the member who owns the nodes to list.
 
 Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
- status(NodeStatus) / set_status(Option<NodeStatus>):
 An optional status specifier. If provided, only nodes currently in this status are listed.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of nodes to list.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On success, responds with ListNodesOutput with field(s):
- nodes(Option<Vec<NodeSummary>>):
 An array of NodeSummary objects that contain configuration properties for each node.
- next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On failure, responds with SdkError<ListNodesError>

source

pub fn list_proposals(&self) -> ListProposals

Constructs a fluent builder for the ListProposals operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of proposals to return.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On success, responds with ListProposalsOutput with field(s):
- proposals(Option<Vec<ProposalSummary>>):
 The summary of each proposal made on the network.
- next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On failure, responds with SdkError<ListProposalsError>

source

pub fn list_proposal_votes(&self) -> ListProposalVotes

Constructs a fluent builder for the ListProposalVotes operation. This operation supports pagination; See into_paginator().

The fluent builder is configurable:
- network_id(impl Into<String>) / set_network_id(Option<String>):
 The unique identifier of the network.
- proposal_id(impl Into<String>) / set_proposal_id(Option<String>):
 The unique identifier of the proposal.
- max_results(i32) / set_max_results(Option<i32>):
 The maximum number of votes to return.
- next_token(impl Into<String>) / set_next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On success, responds with ListProposalVotesOutput with field(s):
- proposal_votes(Option<Vec<VoteSummary>>):
 The list of votes.
- next_token(Option<String>):
 The pagination token that indicates the next set of results to retrieve.
On failure, responds with SdkError<ListProposalVotesError>

source

pub fn list_tags_for_resource(&self) -> ListTagsForResource

Constructs a fluent builder for the ListTagsForResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.
On success, responds with ListTagsForResourceOutput with field(s):
- tags(Option<HashMap<String, String>>):
 The tags assigned to the resource.
On failure, responds with SdkError<ListTagsForResourceError>

source

pub fn reject_invitation(&self) -> RejectInvitation

Constructs a fluent builder for the RejectInvitation operation.

The fluent builder is configurable:
- invitation_id(impl Into<String>) / set_invitation_id(Option<String>):
 The unique identifier of the invitation to reject.
On success, responds with RejectInvitationOutput
On failure, responds with SdkError<RejectInvitationError>

source

pub fn tag_resource(&self) -> TagResource

Constructs a fluent builder for the TagResource operation.

The fluent builder is configurable:
- resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
 The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the AWS General Reference.
- tags(HashMap<String, String>) / set_tags(Option<HashMap<String, String>>):
 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.
On success, responds with TagResourceOutput
On failure, responds with SdkError<TagResourceError>