@aws-sdk/client-managedblockchain 3.296.0 → 3.297.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist-types/ManagedBlockchain.d.ts +28 -0
  2. package/dist-types/ManagedBlockchainClient.d.ts +24 -4
  3. package/dist-types/commands/CreateAccessorCommand.d.ts +16 -0
  4. package/dist-types/commands/CreateMemberCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateNetworkCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateNodeCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateProposalCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteAccessorCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteMemberCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteNodeCommand.d.ts +16 -0
  11. package/dist-types/commands/GetAccessorCommand.d.ts +16 -0
  12. package/dist-types/commands/GetMemberCommand.d.ts +16 -0
  13. package/dist-types/commands/GetNetworkCommand.d.ts +16 -0
  14. package/dist-types/commands/GetNodeCommand.d.ts +16 -0
  15. package/dist-types/commands/GetProposalCommand.d.ts +16 -0
  16. package/dist-types/commands/ListAccessorsCommand.d.ts +16 -0
  17. package/dist-types/commands/ListInvitationsCommand.d.ts +16 -0
  18. package/dist-types/commands/ListMembersCommand.d.ts +16 -0
  19. package/dist-types/commands/ListNetworksCommand.d.ts +16 -0
  20. package/dist-types/commands/ListNodesCommand.d.ts +16 -0
  21. package/dist-types/commands/ListProposalVotesCommand.d.ts +16 -0
  22. package/dist-types/commands/ListProposalsCommand.d.ts +16 -0
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  24. package/dist-types/commands/RejectInvitationCommand.d.ts +16 -0
  25. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateMemberCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateNodeCommand.d.ts +16 -0
  29. package/dist-types/commands/VoteOnProposalCommand.d.ts +16 -0
  30. package/dist-types/models/ManagedBlockchainServiceException.d.ts +2 -0
  31. package/dist-types/models/models_0.d.ts +245 -0
  32. package/dist-types/pagination/Interfaces.d.ts +3 -0
  33. package/dist-types/pagination/ListAccessorsPaginator.d.ts +3 -0
  34. package/dist-types/pagination/ListInvitationsPaginator.d.ts +3 -0
  35. package/dist-types/pagination/ListMembersPaginator.d.ts +3 -0
  36. package/dist-types/pagination/ListNetworksPaginator.d.ts +3 -0
  37. package/dist-types/pagination/ListNodesPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListProposalVotesPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListProposalsPaginator.d.ts +3 -0
  40. package/package.json +3 -3
@@ -28,6 +28,7 @@ import { UpdateNodeCommandInput, UpdateNodeCommandOutput } from "./commands/Upda
28
28
  import { VoteOnProposalCommandInput, VoteOnProposalCommandOutput } from "./commands/VoteOnProposalCommand";
29
29
  import { ManagedBlockchainClient } from "./ManagedBlockchainClient";
30
30
  /**
31
+ * @public
31
32
  * <p></p>
32
33
  * <p>Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.</p>
33
34
  * <p>Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as <code>CreateMember</code> and <code>DeleteMember</code> don't apply to Ethereum.</p>
@@ -35,6 +36,7 @@ import { ManagedBlockchainClient } from "./ManagedBlockchainClient";
35
36
  */
36
37
  export declare class ManagedBlockchain extends ManagedBlockchainClient {
37
38
  /**
39
+ * @public
38
40
  * <p>Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor contains information
39
41
  * required for token based access to your Ethereum nodes.</p>
40
42
  */
@@ -42,6 +44,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
42
44
  createAccessor(args: CreateAccessorCommandInput, cb: (err: any, data?: CreateAccessorCommandOutput) => void): void;
43
45
  createAccessor(args: CreateAccessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessorCommandOutput) => void): void;
44
46
  /**
47
+ * @public
45
48
  * <p>Creates a member within a Managed Blockchain network.</p>
46
49
  * <p>Applies only to Hyperledger Fabric.</p>
47
50
  */
@@ -49,6 +52,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
49
52
  createMember(args: CreateMemberCommandInput, cb: (err: any, data?: CreateMemberCommandOutput) => void): void;
50
53
  createMember(args: CreateMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMemberCommandOutput) => void): void;
51
54
  /**
55
+ * @public
52
56
  * <p>Creates a new blockchain network using Amazon Managed Blockchain.</p>
53
57
  * <p>Applies only to Hyperledger Fabric.</p>
54
58
  */
@@ -56,6 +60,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
56
60
  createNetwork(args: CreateNetworkCommandInput, cb: (err: any, data?: CreateNetworkCommandOutput) => void): void;
57
61
  createNetwork(args: CreateNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNetworkCommandOutput) => void): void;
58
62
  /**
63
+ * @public
59
64
  * <p>Creates a node on the specified blockchain network.</p>
60
65
  * <p>Applies to Hyperledger Fabric and Ethereum.</p>
61
66
  */
@@ -63,6 +68,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
63
68
  createNode(args: CreateNodeCommandInput, cb: (err: any, data?: CreateNodeCommandOutput) => void): void;
64
69
  createNode(args: CreateNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateNodeCommandOutput) => void): void;
65
70
  /**
71
+ * @public
66
72
  * <p>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.</p>
67
73
  * <p>Applies only to Hyperledger Fabric.</p>
68
74
  */
@@ -70,6 +76,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
70
76
  createProposal(args: CreateProposalCommandInput, cb: (err: any, data?: CreateProposalCommandOutput) => void): void;
71
77
  createProposal(args: CreateProposalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateProposalCommandOutput) => void): void;
72
78
  /**
79
+ * @public
73
80
  * <p>Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the
74
81
  * information required for token based access to your Ethereum nodes including, the
75
82
  * <code>BILLING_TOKEN</code>. After an accessor is deleted, the status of the accessor changes
@@ -82,6 +89,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
82
89
  deleteAccessor(args: DeleteAccessorCommandInput, cb: (err: any, data?: DeleteAccessorCommandOutput) => void): void;
83
90
  deleteAccessor(args: DeleteAccessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessorCommandOutput) => void): void;
84
91
  /**
92
+ * @public
85
93
  * <p>Deletes a member. Deleting a member removes the member and all associated resources from the network. <code>DeleteMember</code> can only be called for a specified <code>MemberId</code> if the principal performing the action is associated with the Amazon Web Services account that owns the member. In all other cases, the <code>DeleteMember</code> action is carried out as the result of an approved proposal to remove a member. If <code>MemberId</code> is the last member in a network specified by the last Amazon Web Services account, the network is deleted also.</p>
86
94
  * <p>Applies only to Hyperledger Fabric.</p>
87
95
  */
@@ -89,6 +97,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
89
97
  deleteMember(args: DeleteMemberCommandInput, cb: (err: any, data?: DeleteMemberCommandOutput) => void): void;
90
98
  deleteMember(args: DeleteMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMemberCommandOutput) => void): void;
91
99
  /**
100
+ * @public
92
101
  * <p>Deletes a node that your Amazon Web Services account owns. All data on the node is lost and cannot be recovered.</p>
93
102
  * <p>Applies to Hyperledger Fabric and Ethereum.</p>
94
103
  */
@@ -96,6 +105,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
96
105
  deleteNode(args: DeleteNodeCommandInput, cb: (err: any, data?: DeleteNodeCommandOutput) => void): void;
97
106
  deleteNode(args: DeleteNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteNodeCommandOutput) => void): void;
98
107
  /**
108
+ * @public
99
109
  * <p>Returns detailed information about an accessor. An accessor object is a container that has the
100
110
  * information required for token based access to your Ethereum nodes.</p>
101
111
  */
@@ -103,6 +113,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
103
113
  getAccessor(args: GetAccessorCommandInput, cb: (err: any, data?: GetAccessorCommandOutput) => void): void;
104
114
  getAccessor(args: GetAccessorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAccessorCommandOutput) => void): void;
105
115
  /**
116
+ * @public
106
117
  * <p>Returns detailed information about a member.</p>
107
118
  * <p>Applies only to Hyperledger Fabric.</p>
108
119
  */
@@ -110,6 +121,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
110
121
  getMember(args: GetMemberCommandInput, cb: (err: any, data?: GetMemberCommandOutput) => void): void;
111
122
  getMember(args: GetMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMemberCommandOutput) => void): void;
112
123
  /**
124
+ * @public
113
125
  * <p>Returns detailed information about a network.</p>
114
126
  * <p>Applies to Hyperledger Fabric and Ethereum.</p>
115
127
  */
@@ -117,6 +129,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
117
129
  getNetwork(args: GetNetworkCommandInput, cb: (err: any, data?: GetNetworkCommandOutput) => void): void;
118
130
  getNetwork(args: GetNetworkCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNetworkCommandOutput) => void): void;
119
131
  /**
132
+ * @public
120
133
  * <p>Returns detailed information about a node.</p>
121
134
  * <p>Applies to Hyperledger Fabric and Ethereum.</p>
122
135
  */
@@ -124,6 +137,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
124
137
  getNode(args: GetNodeCommandInput, cb: (err: any, data?: GetNodeCommandOutput) => void): void;
125
138
  getNode(args: GetNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetNodeCommandOutput) => void): void;
126
139
  /**
140
+ * @public
127
141
  * <p>Returns detailed information about a proposal.</p>
128
142
  * <p>Applies only to Hyperledger Fabric.</p>
129
143
  */
@@ -131,6 +145,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
131
145
  getProposal(args: GetProposalCommandInput, cb: (err: any, data?: GetProposalCommandOutput) => void): void;
132
146
  getProposal(args: GetProposalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProposalCommandOutput) => void): void;
133
147
  /**
148
+ * @public
134
149
  * <p>Returns a list of the accessors and their properties. Accessor objects are containers that have the
135
150
  * information required for token based access to your Ethereum nodes.</p>
136
151
  */
@@ -138,6 +153,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
138
153
  listAccessors(args: ListAccessorsCommandInput, cb: (err: any, data?: ListAccessorsCommandOutput) => void): void;
139
154
  listAccessors(args: ListAccessorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessorsCommandOutput) => void): void;
140
155
  /**
156
+ * @public
141
157
  * <p>Returns a list of all invitations for the current Amazon Web Services account.</p>
142
158
  * <p>Applies only to Hyperledger Fabric.</p>
143
159
  */
@@ -145,6 +161,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
145
161
  listInvitations(args: ListInvitationsCommandInput, cb: (err: any, data?: ListInvitationsCommandOutput) => void): void;
146
162
  listInvitations(args: ListInvitationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListInvitationsCommandOutput) => void): void;
147
163
  /**
164
+ * @public
148
165
  * <p>Returns a list of the members in a network and properties of their configurations.</p>
149
166
  * <p>Applies only to Hyperledger Fabric.</p>
150
167
  */
@@ -152,6 +169,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
152
169
  listMembers(args: ListMembersCommandInput, cb: (err: any, data?: ListMembersCommandOutput) => void): void;
153
170
  listMembers(args: ListMembersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMembersCommandOutput) => void): void;
154
171
  /**
172
+ * @public
155
173
  * <p>Returns information about the networks in which the current Amazon Web Services account participates.</p>
156
174
  * <p>Applies to Hyperledger Fabric and Ethereum.</p>
157
175
  */
@@ -159,6 +177,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
159
177
  listNetworks(args: ListNetworksCommandInput, cb: (err: any, data?: ListNetworksCommandOutput) => void): void;
160
178
  listNetworks(args: ListNetworksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNetworksCommandOutput) => void): void;
161
179
  /**
180
+ * @public
162
181
  * <p>Returns information about the nodes within a network.</p>
163
182
  * <p>Applies to Hyperledger Fabric and Ethereum.</p>
164
183
  */
@@ -166,6 +185,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
166
185
  listNodes(args: ListNodesCommandInput, cb: (err: any, data?: ListNodesCommandOutput) => void): void;
167
186
  listNodes(args: ListNodesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListNodesCommandOutput) => void): void;
168
187
  /**
188
+ * @public
169
189
  * <p>Returns a list of proposals for the network.</p>
170
190
  * <p>Applies only to Hyperledger Fabric.</p>
171
191
  */
@@ -173,6 +193,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
173
193
  listProposals(args: ListProposalsCommandInput, cb: (err: any, data?: ListProposalsCommandOutput) => void): void;
174
194
  listProposals(args: ListProposalsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProposalsCommandOutput) => void): void;
175
195
  /**
196
+ * @public
176
197
  * <p>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.</p>
177
198
  * <p>Applies only to Hyperledger Fabric.</p>
178
199
  */
@@ -180,6 +201,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
180
201
  listProposalVotes(args: ListProposalVotesCommandInput, cb: (err: any, data?: ListProposalVotesCommandOutput) => void): void;
181
202
  listProposalVotes(args: ListProposalVotesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProposalVotesCommandOutput) => void): void;
182
203
  /**
204
+ * @public
183
205
  * <p>Returns a list of tags for the specified resource. Each tag consists of a key and optional value.</p>
184
206
  * <p>For more information about tags, see <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href="https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>
185
207
  */
@@ -187,6 +209,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
187
209
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
188
210
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
189
211
  /**
212
+ * @public
190
213
  * <p>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.</p>
191
214
  * <p>Applies only to Hyperledger Fabric.</p>
192
215
  */
@@ -194,6 +217,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
194
217
  rejectInvitation(args: RejectInvitationCommandInput, cb: (err: any, data?: RejectInvitationCommandOutput) => void): void;
195
218
  rejectInvitation(args: RejectInvitationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RejectInvitationCommandOutput) => void): void;
196
219
  /**
220
+ * @public
197
221
  * <p>Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource. Each tag consists of a key and optional value.</p>
198
222
  * <p>When you specify a tag key that already exists, the tag value is overwritten with the new value. Use <code>UntagResource</code> to remove tag keys.</p>
199
223
  * <p>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.</p>
@@ -203,6 +227,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
203
227
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
204
228
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
205
229
  /**
230
+ * @public
206
231
  * <p>Removes the specified tags from the Amazon Managed Blockchain resource.</p>
207
232
  * <p>For more information about tags, see <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href="https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>
208
233
  */
@@ -210,6 +235,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
210
235
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
211
236
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
212
237
  /**
238
+ * @public
213
239
  * <p>Updates a member configuration with new parameters.</p>
214
240
  * <p>Applies only to Hyperledger Fabric.</p>
215
241
  */
@@ -217,6 +243,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
217
243
  updateMember(args: UpdateMemberCommandInput, cb: (err: any, data?: UpdateMemberCommandOutput) => void): void;
218
244
  updateMember(args: UpdateMemberCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMemberCommandOutput) => void): void;
219
245
  /**
246
+ * @public
220
247
  * <p>Updates a node configuration with new parameters.</p>
221
248
  * <p>Applies only to Hyperledger Fabric.</p>
222
249
  */
@@ -224,6 +251,7 @@ export declare class ManagedBlockchain extends ManagedBlockchainClient {
224
251
  updateNode(args: UpdateNodeCommandInput, cb: (err: any, data?: UpdateNodeCommandOutput) => void): void;
225
252
  updateNode(args: UpdateNodeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateNodeCommandOutput) => void): void;
226
253
  /**
254
+ * @public
227
255
  * <p>Casts a vote for a specified <code>ProposalId</code> on behalf of a member. The member to vote as, specified by <code>VoterMemberId</code>, must be in the same Amazon Web Services account as the principal that calls the action.</p>
228
256
  * <p>Applies only to Hyperledger Fabric.</p>
229
257
  */
@@ -35,15 +35,24 @@ import { UpdateMemberCommandInput, UpdateMemberCommandOutput } from "./commands/
35
35
  import { UpdateNodeCommandInput, UpdateNodeCommandOutput } from "./commands/UpdateNodeCommand";
36
36
  import { VoteOnProposalCommandInput, VoteOnProposalCommandOutput } from "./commands/VoteOnProposalCommand";
37
37
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
38
+ /**
39
+ * @public
40
+ */
38
41
  export type ServiceInputTypes = CreateAccessorCommandInput | CreateMemberCommandInput | CreateNetworkCommandInput | CreateNodeCommandInput | CreateProposalCommandInput | DeleteAccessorCommandInput | DeleteMemberCommandInput | DeleteNodeCommandInput | GetAccessorCommandInput | GetMemberCommandInput | GetNetworkCommandInput | GetNodeCommandInput | GetProposalCommandInput | ListAccessorsCommandInput | ListInvitationsCommandInput | ListMembersCommandInput | ListNetworksCommandInput | ListNodesCommandInput | ListProposalVotesCommandInput | ListProposalsCommandInput | ListTagsForResourceCommandInput | RejectInvitationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateMemberCommandInput | UpdateNodeCommandInput | VoteOnProposalCommandInput;
42
+ /**
43
+ * @public
44
+ */
39
45
  export type ServiceOutputTypes = CreateAccessorCommandOutput | CreateMemberCommandOutput | CreateNetworkCommandOutput | CreateNodeCommandOutput | CreateProposalCommandOutput | DeleteAccessorCommandOutput | DeleteMemberCommandOutput | DeleteNodeCommandOutput | GetAccessorCommandOutput | GetMemberCommandOutput | GetNetworkCommandOutput | GetNodeCommandOutput | GetProposalCommandOutput | ListAccessorsCommandOutput | ListInvitationsCommandOutput | ListMembersCommandOutput | ListNetworksCommandOutput | ListNodesCommandOutput | ListProposalVotesCommandOutput | ListProposalsCommandOutput | ListTagsForResourceCommandOutput | RejectInvitationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateMemberCommandOutput | UpdateNodeCommandOutput | VoteOnProposalCommandOutput;
46
+ /**
47
+ * @public
48
+ */
40
49
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
41
50
  /**
42
51
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
43
52
  */
44
53
  requestHandler?: __HttpHandler;
45
54
  /**
46
- * A constructor for a class implementing the {@link __Checksum} interface
55
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
47
56
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
48
57
  * @internal
49
58
  */
@@ -133,23 +142,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
133
142
  */
134
143
  logger?: __Logger;
135
144
  /**
136
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
145
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
137
146
  */
138
147
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
139
148
  }
149
+ /**
150
+ * @public
151
+ */
140
152
  type ManagedBlockchainClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
141
153
  /**
142
- * The configuration interface of ManagedBlockchainClient class constructor that set the region, credentials and other options.
154
+ * @public
155
+ *
156
+ * The configuration interface of ManagedBlockchainClient class constructor that set the region, credentials and other options.
143
157
  */
144
158
  export interface ManagedBlockchainClientConfig extends ManagedBlockchainClientConfigType {
145
159
  }
160
+ /**
161
+ * @public
162
+ */
146
163
  type ManagedBlockchainClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
147
164
  /**
148
- * The resolved configuration interface of ManagedBlockchainClient class. This is resolved and normalized from the {@link ManagedBlockchainClientConfig | constructor configuration interface}.
165
+ * @public
166
+ *
167
+ * The resolved configuration interface of ManagedBlockchainClient class. This is resolved and normalized from the {@link ManagedBlockchainClientConfig | constructor configuration interface}.
149
168
  */
150
169
  export interface ManagedBlockchainClientResolvedConfig extends ManagedBlockchainClientResolvedConfigType {
151
170
  }
152
171
  /**
172
+ * @public
153
173
  * <p></p>
154
174
  * <p>Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.</p>
155
175
  * <p>Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as <code>CreateMember</code> and <code>DeleteMember</code> don't apply to Ethereum.</p>
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ManagedBlockchainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ManagedBlockchainClient";
5
5
  import { CreateAccessorInput, CreateAccessorOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateAccessorCommand}.
8
10
  */
9
11
  export interface CreateAccessorCommandInput extends CreateAccessorInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateAccessorCommand}.
13
17
  */
14
18
  export interface CreateAccessorCommandOutput extends CreateAccessorOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor contains information
18
23
  * required for token based access to your Ethereum nodes.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateAccessorCommandOutput extends CreateAccessorOutput, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateAccessorCommandInput - {@link CreateAccessorCommandInput}
35
+ * @returns {@link CreateAccessorCommandOutput}
29
36
  * @see {@link CreateAccessorCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateAccessorCommandOutput} for command's `response` shape.
31
38
  * @see {@link ManagedBlockchainClientResolvedConfig | config} for ManagedBlockchainClient's `config` shape.
@@ -60,11 +67,20 @@ export interface CreateAccessorCommandOutput extends CreateAccessorOutput, __Met
60
67
  export declare class CreateAccessorCommand extends $Command<CreateAccessorCommandInput, CreateAccessorCommandOutput, ManagedBlockchainClientResolvedConfig> {
61
68
  readonly input: CreateAccessorCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: CreateAccessorCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ManagedBlockchainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessorCommandInput, CreateAccessorCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ManagedBlockchainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ManagedBlockchainClient";
5
5
  import { CreateMemberInput, CreateMemberOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateMemberCommand}.
8
10
  */
9
11
  export interface CreateMemberCommandInput extends CreateMemberInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateMemberCommand}.
13
17
  */
14
18
  export interface CreateMemberCommandOutput extends CreateMemberOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a member within a Managed Blockchain network.</p>
18
23
  * <p>Applies only to Hyperledger Fabric.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateMemberCommandOutput extends CreateMemberOutput, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateMemberCommandInput - {@link CreateMemberCommandInput}
35
+ * @returns {@link CreateMemberCommandOutput}
29
36
  * @see {@link CreateMemberCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateMemberCommandOutput} for command's `response` shape.
31
38
  * @see {@link ManagedBlockchainClientResolvedConfig | config} for ManagedBlockchainClient's `config` shape.
@@ -66,11 +73,20 @@ export interface CreateMemberCommandOutput extends CreateMemberOutput, __Metadat
66
73
  export declare class CreateMemberCommand extends $Command<CreateMemberCommandInput, CreateMemberCommandOutput, ManagedBlockchainClientResolvedConfig> {
67
74
  readonly input: CreateMemberCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: CreateMemberCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ManagedBlockchainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateMemberCommandInput, CreateMemberCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ManagedBlockchainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ManagedBlockchainClient";
5
5
  import { CreateNetworkInput, CreateNetworkOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateNetworkCommand}.
8
10
  */
9
11
  export interface CreateNetworkCommandInput extends CreateNetworkInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateNetworkCommand}.
13
17
  */
14
18
  export interface CreateNetworkCommandOutput extends CreateNetworkOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new blockchain network using Amazon Managed Blockchain.</p>
18
23
  * <p>Applies only to Hyperledger Fabric.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateNetworkCommandOutput extends CreateNetworkOutput, __Metad
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateNetworkCommandInput - {@link CreateNetworkCommandInput}
35
+ * @returns {@link CreateNetworkCommandOutput}
29
36
  * @see {@link CreateNetworkCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateNetworkCommandOutput} for command's `response` shape.
31
38
  * @see {@link ManagedBlockchainClientResolvedConfig | config} for ManagedBlockchainClient's `config` shape.
@@ -60,11 +67,20 @@ export interface CreateNetworkCommandOutput extends CreateNetworkOutput, __Metad
60
67
  export declare class CreateNetworkCommand extends $Command<CreateNetworkCommandInput, CreateNetworkCommandOutput, ManagedBlockchainClientResolvedConfig> {
61
68
  readonly input: CreateNetworkCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: CreateNetworkCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ManagedBlockchainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateNetworkCommandInput, CreateNetworkCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ManagedBlockchainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ManagedBlockchainClient";
5
5
  import { CreateNodeInput, CreateNodeOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateNodeCommand}.
8
10
  */
9
11
  export interface CreateNodeCommandInput extends CreateNodeInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateNodeCommand}.
13
17
  */
14
18
  export interface CreateNodeCommandOutput extends CreateNodeOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a node on the specified blockchain network.</p>
18
23
  * <p>Applies to Hyperledger Fabric and Ethereum.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateNodeCommandOutput extends CreateNodeOutput, __MetadataBea
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateNodeCommandInput - {@link CreateNodeCommandInput}
35
+ * @returns {@link CreateNodeCommandOutput}
29
36
  * @see {@link CreateNodeCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateNodeCommandOutput} for command's `response` shape.
31
38
  * @see {@link ManagedBlockchainClientResolvedConfig | config} for ManagedBlockchainClient's `config` shape.
@@ -66,11 +73,20 @@ export interface CreateNodeCommandOutput extends CreateNodeOutput, __MetadataBea
66
73
  export declare class CreateNodeCommand extends $Command<CreateNodeCommandInput, CreateNodeCommandOutput, ManagedBlockchainClientResolvedConfig> {
67
74
  readonly input: CreateNodeCommandInput;
68
75
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
76
+ /**
77
+ * @public
78
+ */
69
79
  constructor(input: CreateNodeCommandInput);
70
80
  /**
71
81
  * @internal
72
82
  */
73
83
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ManagedBlockchainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateNodeCommandInput, CreateNodeCommandOutput>;
84
+ /**
85
+ * @internal
86
+ */
74
87
  private serialize;
88
+ /**
89
+ * @internal
90
+ */
75
91
  private deserialize;
76
92
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ManagedBlockchainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ManagedBlockchainClient";
5
5
  import { CreateProposalInput, CreateProposalOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateProposalCommand}.
8
10
  */
9
11
  export interface CreateProposalCommandInput extends CreateProposalInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateProposalCommand}.
13
17
  */
14
18
  export interface CreateProposalCommandOutput extends CreateProposalOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>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.</p>
18
23
  * <p>Applies only to Hyperledger Fabric.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface CreateProposalCommandOutput extends CreateProposalOutput, __Met
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param CreateProposalCommandInput - {@link CreateProposalCommandInput}
35
+ * @returns {@link CreateProposalCommandOutput}
29
36
  * @see {@link CreateProposalCommandInput} for command's `input` shape.
30
37
  * @see {@link CreateProposalCommandOutput} for command's `response` shape.
31
38
  * @see {@link ManagedBlockchainClientResolvedConfig | config} for ManagedBlockchainClient's `config` shape.
@@ -59,11 +66,20 @@ export interface CreateProposalCommandOutput extends CreateProposalOutput, __Met
59
66
  export declare class CreateProposalCommand extends $Command<CreateProposalCommandInput, CreateProposalCommandOutput, ManagedBlockchainClientResolvedConfig> {
60
67
  readonly input: CreateProposalCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: CreateProposalCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ManagedBlockchainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateProposalCommandInput, CreateProposalCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ManagedBlockchainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ManagedBlockchainClient";
5
5
  import { DeleteAccessorInput, DeleteAccessorOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteAccessorCommand}.
8
10
  */
9
11
  export interface DeleteAccessorCommandInput extends DeleteAccessorInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteAccessorCommand}.
13
17
  */
14
18
  export interface DeleteAccessorCommandOutput extends DeleteAccessorOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the
18
23
  * information required for token based access to your Ethereum nodes including, the
19
24
  * <code>BILLING_TOKEN</code>. After an accessor is deleted, the status of the accessor changes
@@ -31,6 +36,8 @@ export interface DeleteAccessorCommandOutput extends DeleteAccessorOutput, __Met
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param DeleteAccessorCommandInput - {@link DeleteAccessorCommandInput}
40
+ * @returns {@link DeleteAccessorCommandOutput}
34
41
  * @see {@link DeleteAccessorCommandInput} for command's `input` shape.
35
42
  * @see {@link DeleteAccessorCommandOutput} for command's `response` shape.
36
43
  * @see {@link ManagedBlockchainClientResolvedConfig | config} for ManagedBlockchainClient's `config` shape.
@@ -58,11 +65,20 @@ export interface DeleteAccessorCommandOutput extends DeleteAccessorOutput, __Met
58
65
  export declare class DeleteAccessorCommand extends $Command<DeleteAccessorCommandInput, DeleteAccessorCommandOutput, ManagedBlockchainClientResolvedConfig> {
59
66
  readonly input: DeleteAccessorCommandInput;
60
67
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
68
+ /**
69
+ * @public
70
+ */
61
71
  constructor(input: DeleteAccessorCommandInput);
62
72
  /**
63
73
  * @internal
64
74
  */
65
75
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ManagedBlockchainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAccessorCommandInput, DeleteAccessorCommandOutput>;
76
+ /**
77
+ * @internal
78
+ */
66
79
  private serialize;
80
+ /**
81
+ * @internal
82
+ */
67
83
  private deserialize;
68
84
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ManagedBlockchainClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ManagedBlockchainClient";
5
5
  import { DeleteMemberInput, DeleteMemberOutput } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteMemberCommand}.
8
10
  */
9
11
  export interface DeleteMemberCommandInput extends DeleteMemberInput {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteMemberCommand}.
13
17
  */
14
18
  export interface DeleteMemberCommandOutput extends DeleteMemberOutput, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a member. Deleting a member removes the member and all associated resources from the network. <code>DeleteMember</code> can only be called for a specified <code>MemberId</code> if the principal performing the action is associated with the Amazon Web Services account that owns the member. In all other cases, the <code>DeleteMember</code> action is carried out as the result of an approved proposal to remove a member. If <code>MemberId</code> is the last member in a network specified by the last Amazon Web Services account, the network is deleted also.</p>
18
23
  * <p>Applies only to Hyperledger Fabric.</p>
19
24
  * @example
@@ -26,6 +31,8 @@ export interface DeleteMemberCommandOutput extends DeleteMemberOutput, __Metadat
26
31
  * const response = await client.send(command);
27
32
  * ```
28
33
  *
34
+ * @param DeleteMemberCommandInput - {@link DeleteMemberCommandInput}
35
+ * @returns {@link DeleteMemberCommandOutput}
29
36
  * @see {@link DeleteMemberCommandInput} for command's `input` shape.
30
37
  * @see {@link DeleteMemberCommandOutput} for command's `response` shape.
31
38
  * @see {@link ManagedBlockchainClientResolvedConfig | config} for ManagedBlockchainClient's `config` shape.
@@ -56,11 +63,20 @@ export interface DeleteMemberCommandOutput extends DeleteMemberOutput, __Metadat
56
63
  export declare class DeleteMemberCommand extends $Command<DeleteMemberCommandInput, DeleteMemberCommandOutput, ManagedBlockchainClientResolvedConfig> {
57
64
  readonly input: DeleteMemberCommandInput;
58
65
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
66
+ /**
67
+ * @public
68
+ */
59
69
  constructor(input: DeleteMemberCommandInput);
60
70
  /**
61
71
  * @internal
62
72
  */
63
73
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ManagedBlockchainClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMemberCommandInput, DeleteMemberCommandOutput>;
74
+ /**
75
+ * @internal
76
+ */
64
77
  private serialize;
78
+ /**
79
+ * @internal
80
+ */
65
81
  private deserialize;
66
82
  }