{ "version": "2.0", "metadata": { "apiVersion": "2018-09-24", "endpointPrefix": "managedblockchain", "jsonVersion": "1.1", "protocol": "rest-json", "protocols": [ "rest-json" ], "serviceAbbreviation": "ManagedBlockchain", "serviceFullName": "Amazon Managed Blockchain", "serviceId": "ManagedBlockchain", "signatureVersion": "v4", "signingName": "managedblockchain", "uid": "managedblockchain-2018-09-24" }, "operations": { "CreateAccessor": { "name": "CreateAccessor", "http": { "method": "POST", "requestUri": "/accessors" }, "input": { "shape": "CreateAccessorInput" }, "output": { "shape": "CreateAccessorOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceAlreadyExistsException" }, { "shape": "ThrottlingException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "InternalServiceErrorException" }, { "shape": "TooManyTagsException" } ], "documentation": "
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.
" }, "CreateMember": { "name": "CreateMember", "http": { "method": "POST", "requestUri": "/networks/{networkId}/members" }, "input": { "shape": "CreateMemberInput" }, "output": { "shape": "CreateMemberOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceAlreadyExistsException" }, { "shape": "ResourceNotReadyException" }, { "shape": "ThrottlingException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "InternalServiceErrorException" }, { "shape": "TooManyTagsException" } ], "documentation": "Creates a member within a Managed Blockchain network.
Applies only to Hyperledger Fabric.
" }, "CreateNetwork": { "name": "CreateNetwork", "http": { "method": "POST", "requestUri": "/networks" }, "input": { "shape": "CreateNetworkInput" }, "output": { "shape": "CreateNetworkOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceAlreadyExistsException" }, { "shape": "ThrottlingException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "InternalServiceErrorException" }, { "shape": "TooManyTagsException" } ], "documentation": "Creates a new blockchain network using Amazon Managed Blockchain.
Applies only to Hyperledger Fabric.
" }, "CreateNode": { "name": "CreateNode", "http": { "method": "POST", "requestUri": "/networks/{networkId}/nodes" }, "input": { "shape": "CreateNodeInput" }, "output": { "shape": "CreateNodeOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceAlreadyExistsException" }, { "shape": "ResourceNotReadyException" }, { "shape": "ThrottlingException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "InternalServiceErrorException" }, { "shape": "TooManyTagsException" } ], "documentation": "Creates a node on the specified blockchain network.
Applies to Hyperledger Fabric and Ethereum.
" }, "CreateProposal": { "name": "CreateProposal", "http": { "method": "POST", "requestUri": "/networks/{networkId}/proposals" }, "input": { "shape": "CreateProposalInput" }, "output": { "shape": "CreateProposalOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceNotReadyException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" }, { "shape": "TooManyTagsException" } ], "documentation": "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.
" }, "DeleteAccessor": { "name": "DeleteAccessor", "http": { "method": "DELETE", "requestUri": "/accessors/{AccessorId}" }, "input": { "shape": "DeleteAccessorInput" }, "output": { "shape": "DeleteAccessorOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "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).
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.
" }, "DeleteNode": { "name": "DeleteNode", "http": { "method": "DELETE", "requestUri": "/networks/{networkId}/nodes/{nodeId}" }, "input": { "shape": "DeleteNodeInput" }, "output": { "shape": "DeleteNodeOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceNotReadyException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "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.
" }, "GetAccessor": { "name": "GetAccessor", "http": { "method": "GET", "requestUri": "/accessors/{AccessorId}" }, "input": { "shape": "GetAccessorInput" }, "output": { "shape": "GetAccessorOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "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.
" }, "GetMember": { "name": "GetMember", "http": { "method": "GET", "requestUri": "/networks/{networkId}/members/{memberId}" }, "input": { "shape": "GetMemberInput" }, "output": { "shape": "GetMemberOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns detailed information about a member.
Applies only to Hyperledger Fabric.
" }, "GetNetwork": { "name": "GetNetwork", "http": { "method": "GET", "requestUri": "/networks/{networkId}" }, "input": { "shape": "GetNetworkInput" }, "output": { "shape": "GetNetworkOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns detailed information about a network.
Applies to Hyperledger Fabric and Ethereum.
" }, "GetNode": { "name": "GetNode", "http": { "method": "GET", "requestUri": "/networks/{networkId}/nodes/{nodeId}" }, "input": { "shape": "GetNodeInput" }, "output": { "shape": "GetNodeOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns detailed information about a node.
Applies to Hyperledger Fabric and Ethereum.
" }, "GetProposal": { "name": "GetProposal", "http": { "method": "GET", "requestUri": "/networks/{networkId}/proposals/{proposalId}" }, "input": { "shape": "GetProposalInput" }, "output": { "shape": "GetProposalOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns detailed information about a proposal.
Applies only to Hyperledger Fabric.
" }, "ListAccessors": { "name": "ListAccessors", "http": { "method": "GET", "requestUri": "/accessors" }, "input": { "shape": "ListAccessorsInput" }, "output": { "shape": "ListAccessorsOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "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.
" }, "ListInvitations": { "name": "ListInvitations", "http": { "method": "GET", "requestUri": "/invitations" }, "input": { "shape": "ListInvitationsInput" }, "output": { "shape": "ListInvitationsOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "ResourceLimitExceededException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns a list of all invitations for the current Amazon Web Services account.
Applies only to Hyperledger Fabric.
" }, "ListMembers": { "name": "ListMembers", "http": { "method": "GET", "requestUri": "/networks/{networkId}/members" }, "input": { "shape": "ListMembersInput" }, "output": { "shape": "ListMembersOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns a list of the members in a network and properties of their configurations.
Applies only to Hyperledger Fabric.
" }, "ListNetworks": { "name": "ListNetworks", "http": { "method": "GET", "requestUri": "/networks" }, "input": { "shape": "ListNetworksInput" }, "output": { "shape": "ListNetworksOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns information about the networks in which the current Amazon Web Services account participates.
Applies to Hyperledger Fabric and Ethereum.
" }, "ListNodes": { "name": "ListNodes", "http": { "method": "GET", "requestUri": "/networks/{networkId}/nodes" }, "input": { "shape": "ListNodesInput" }, "output": { "shape": "ListNodesOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns information about the nodes within a network.
Applies to Hyperledger Fabric and Ethereum.
" }, "ListProposalVotes": { "name": "ListProposalVotes", "http": { "method": "GET", "requestUri": "/networks/{networkId}/proposals/{proposalId}/votes" }, "input": { "shape": "ListProposalVotesInput" }, "output": { "shape": "ListProposalVotesOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "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.
" }, "ListProposals": { "name": "ListProposals", "http": { "method": "GET", "requestUri": "/networks/{networkId}/proposals" }, "input": { "shape": "ListProposalsInput" }, "output": { "shape": "ListProposalsOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "ResourceNotFoundException" }, { "shape": "AccessDeniedException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Returns a list of proposals for the network.
Applies only to Hyperledger Fabric.
" }, "ListTagsForResource": { "name": "ListTagsForResource", "http": { "method": "GET", "requestUri": "/tags/{resourceArn}" }, "input": { "shape": "ListTagsForResourceRequest" }, "output": { "shape": "ListTagsForResourceResponse" }, "errors": [ { "shape": "InternalServiceErrorException" }, { "shape": "InvalidRequestException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceNotReadyException" } ], "documentation": "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.
" }, "RejectInvitation": { "name": "RejectInvitation", "http": { "method": "DELETE", "requestUri": "/invitations/{invitationId}" }, "input": { "shape": "RejectInvitationInput" }, "output": { "shape": "RejectInvitationOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "IllegalActionException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "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.
" }, "TagResource": { "name": "TagResource", "http": { "method": "POST", "requestUri": "/tags/{resourceArn}" }, "input": { "shape": "TagResourceRequest" }, "output": { "shape": "TagResourceResponse" }, "errors": [ { "shape": "InternalServiceErrorException" }, { "shape": "InvalidRequestException" }, { "shape": "ResourceNotFoundException" }, { "shape": "TooManyTagsException" }, { "shape": "ResourceNotReadyException" } ], "documentation": "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.
" }, "UntagResource": { "name": "UntagResource", "http": { "method": "DELETE", "requestUri": "/tags/{resourceArn}" }, "input": { "shape": "UntagResourceRequest" }, "output": { "shape": "UntagResourceResponse" }, "errors": [ { "shape": "InternalServiceErrorException" }, { "shape": "InvalidRequestException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ResourceNotReadyException" } ], "documentation": "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.
" }, "UpdateMember": { "name": "UpdateMember", "http": { "method": "PATCH", "requestUri": "/networks/{networkId}/members/{memberId}" }, "input": { "shape": "UpdateMemberInput" }, "output": { "shape": "UpdateMemberOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Updates a member configuration with new parameters.
Applies only to Hyperledger Fabric.
" }, "UpdateNode": { "name": "UpdateNode", "http": { "method": "PATCH", "requestUri": "/networks/{networkId}/nodes/{nodeId}" }, "input": { "shape": "UpdateNodeInput" }, "output": { "shape": "UpdateNodeOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "Updates a node configuration with new parameters.
Applies only to Hyperledger Fabric.
" }, "VoteOnProposal": { "name": "VoteOnProposal", "http": { "method": "POST", "requestUri": "/networks/{networkId}/proposals/{proposalId}/votes" }, "input": { "shape": "VoteOnProposalInput" }, "output": { "shape": "VoteOnProposalOutput" }, "errors": [ { "shape": "InvalidRequestException" }, { "shape": "IllegalActionException" }, { "shape": "AccessDeniedException" }, { "shape": "ResourceNotFoundException" }, { "shape": "ThrottlingException" }, { "shape": "InternalServiceErrorException" } ], "documentation": "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.
" } }, "shapes": { "Accessor": { "type": "structure", "members": { "Id": { "shape": "ResourceIdString", "documentation": "The unique identifier of the accessor.
" }, "Type": { "shape": "AccessorType", "documentation": "The type of the accessor.
Currently, accessor type is restricted to BILLING_TOKEN
.
The billing token is a property of the Accessor. Use this token to when making calls to the blockchain network. The billing token is used to track your accessor token for billing requests.
" }, "Status": { "shape": "AccessorStatus", "documentation": "The current status of the accessor.
" }, "CreationDate": { "shape": "Timestamp", "documentation": "The creation date and time of the accessor.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" }, "Tags": { "shape": "OutputTagMap", "documentation": "The tags assigned to the Accessor.
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.
" }, "NetworkType": { "shape": "AccessorNetworkType", "documentation": "The blockchain network that the Accessor token is created for.
" } }, "documentation": "The properties of the Accessor.
" }, "AccessorBillingTokenString": { "type": "string", "max": 42, "min": 42 }, "AccessorListMaxResults": { "type": "integer", "box": true, "max": 50, "min": 1 }, "AccessorNetworkType": { "type": "string", "enum": [ "ETHEREUM_GOERLI", "ETHEREUM_MAINNET", "ETHEREUM_MAINNET_AND_GOERLI", "POLYGON_MAINNET", "POLYGON_MUMBAI" ] }, "AccessorStatus": { "type": "string", "enum": [ "AVAILABLE", "PENDING_DELETION", "DELETED" ] }, "AccessorSummary": { "type": "structure", "members": { "Id": { "shape": "ResourceIdString", "documentation": "The unique identifier of the accessor.
" }, "Type": { "shape": "AccessorType", "documentation": "The type of the accessor.
Currently accessor type is restricted to BILLING_TOKEN
.
The current status of the accessor.
" }, "CreationDate": { "shape": "Timestamp", "documentation": "The creation date and time of the accessor.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" }, "NetworkType": { "shape": "AccessorNetworkType", "documentation": "The blockchain network that the Accessor token is created for.
" } }, "documentation": "A summary of accessor properties.
" }, "AccessorSummaryList": { "type": "list", "member": { "shape": "AccessorSummary" } }, "AccessorType": { "type": "string", "enum": [ "BILLING_TOKEN" ] }, "ApprovalThresholdPolicy": { "type": "structure", "members": { "ThresholdPercentage": { "shape": "ThresholdPercentageInt", "documentation": "The percentage of votes among all members that must be YES
for a proposal to be approved. For example, a ThresholdPercentage
value of 50
indicates 50%. The ThresholdComparator
determines the precise comparison. If a ThresholdPercentage
value of 50
is specified on a network with 10 members, along with a ThresholdComparator
value of GREATER_THAN
, this indicates that 6 YES
votes are required for the proposal to be approved.
The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES
votes to approve the proposal nor the number of NO
votes required to reject it before the duration expires, the proposal is EXPIRED
and ProposalActions
aren't carried out.
Determines whether the vote percentage must be greater than the ThresholdPercentage
or must be greater than or equal to the ThresholdPercentage
to be approved.
A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES
votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.
Applies only to Hyperledger Fabric.
" }, "ArnString": { "type": "string", "max": 1011, "min": 1, "pattern": "^arn:.+:.+:.+:.+:.+" }, "AvailabilityZoneString": { "type": "string" }, "ClientRequestTokenString": { "type": "string", "max": 64, "min": 1 }, "CreateAccessorInput": { "type": "structure", "required": [ "ClientRequestToken", "AccessorType" ], "members": { "ClientRequestToken": { "shape": "ClientRequestTokenString", "documentation": "This is a unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon Web Services CLI.
", "idempotencyToken": true }, "AccessorType": { "shape": "AccessorType", "documentation": "The type of accessor.
Currently, accessor type is restricted to BILLING_TOKEN
.
Tags to assign to the Accessor.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per 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.
" }, "NetworkType": { "shape": "AccessorNetworkType", "documentation": "The blockchain network that the Accessor
token is created for.
Use the actual networkType
value for the blockchain network that you are creating the Accessor
token for.
With the shut down of the Ethereum Goerli and Polygon Mumbai Testnet networks the following networkType
values are no longer available for selection and use.
ETHEREUM_MAINNET_AND_GOERLI
ETHEREUM_GOERLI
POLYGON_MUMBAI
However, your existing Accessor
tokens with these networkType
values will remain unchanged.
The unique identifier of the accessor.
" }, "BillingToken": { "shape": "AccessorBillingTokenString", "documentation": "The billing token is a property of the Accessor. Use this token to when making calls to the blockchain network. The billing token is used to track your accessor token for billing requests.
" }, "NetworkType": { "shape": "AccessorNetworkType", "documentation": "The blockchain network that the accessor token is created for.
" } } }, "CreateMemberInput": { "type": "structure", "required": [ "ClientRequestToken", "InvitationId", "NetworkId", "MemberConfiguration" ], "members": { "ClientRequestToken": { "shape": "ClientRequestTokenString", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the CLI.
", "idempotencyToken": true }, "InvitationId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the invitation that is sent to the member to join the network.
" }, "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network in which the member is created.
", "location": "uri", "locationName": "networkId" }, "MemberConfiguration": { "shape": "MemberConfiguration", "documentation": "Member configuration parameters.
" } } }, "CreateMemberOutput": { "type": "structure", "members": { "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member.
" } } }, "CreateNetworkInput": { "type": "structure", "required": [ "ClientRequestToken", "Name", "Framework", "FrameworkVersion", "VotingPolicy", "MemberConfiguration" ], "members": { "ClientRequestToken": { "shape": "ClientRequestTokenString", "documentation": "This is a unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon Web Services CLI.
", "idempotencyToken": true }, "Name": { "shape": "NameString", "documentation": "The name of the network.
" }, "Description": { "shape": "DescriptionString", "documentation": "An optional description for the network.
" }, "Framework": { "shape": "Framework", "documentation": "The blockchain framework that the network uses.
" }, "FrameworkVersion": { "shape": "FrameworkVersionString", "documentation": "The version of the blockchain framework that the network uses.
" }, "FrameworkConfiguration": { "shape": "NetworkFrameworkConfiguration", "documentation": "Configuration properties of the blockchain framework relevant to the network configuration.
" }, "VotingPolicy": { "shape": "VotingPolicy", "documentation": "The voting rules used by the network to determine if a proposal is approved.
" }, "MemberConfiguration": { "shape": "MemberConfiguration", "documentation": "Configuration properties for the first member within the network.
" }, "Tags": { "shape": "InputTagMap", "documentation": "Tags to assign to the network.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per 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.
" } } }, "CreateNetworkOutput": { "type": "structure", "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier for the network.
" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier for the first member within the network.
" } } }, "CreateNodeInput": { "type": "structure", "required": [ "ClientRequestToken", "NetworkId", "NodeConfiguration" ], "members": { "ClientRequestToken": { "shape": "ClientRequestTokenString", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the CLI.
", "idempotencyToken": true }, "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network for the node.
Ethereum public networks have the following NetworkId
s:
n-ethereum-mainnet
The unique identifier of the member that owns this node.
Applies only to Hyperledger Fabric.
" }, "NodeConfiguration": { "shape": "NodeConfiguration", "documentation": "The properties of a node configuration.
" }, "Tags": { "shape": "InputTagMap", "documentation": "Tags to assign to the node.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per 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.
" } } }, "CreateNodeOutput": { "type": "structure", "members": { "NodeId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the node.
" } } }, "CreateProposalInput": { "type": "structure", "required": [ "ClientRequestToken", "NetworkId", "MemberId", "Actions" ], "members": { "ClientRequestToken": { "shape": "ClientRequestTokenString", "documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the CLI.
", "idempotencyToken": true }, "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network for which the proposal is made.
", "location": "uri", "locationName": "networkId" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single Amazon Web Services account.
" }, "Actions": { "shape": "ProposalActions", "documentation": "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.
A description for the proposal that is visible to voting members, for example, \"Proposal to add Example Corp. as member.\"
" }, "Tags": { "shape": "InputTagMap", "documentation": "Tags to assign to the proposal.
Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per 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.
" } } }, "CreateProposalOutput": { "type": "structure", "members": { "ProposalId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the proposal.
" } } }, "DeleteAccessorInput": { "type": "structure", "required": [ "AccessorId" ], "members": { "AccessorId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the accessor.
", "location": "uri", "locationName": "AccessorId" } } }, "DeleteAccessorOutput": { "type": "structure", "members": {} }, "DeleteMemberInput": { "type": "structure", "required": [ "NetworkId", "MemberId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network from which the member is removed.
", "location": "uri", "locationName": "networkId" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member to remove.
", "location": "uri", "locationName": "memberId" } } }, "DeleteMemberOutput": { "type": "structure", "members": {} }, "DeleteNodeInput": { "type": "structure", "required": [ "NetworkId", "NodeId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network that the node is on.
Ethereum public networks have the following NetworkId
s:
n-ethereum-mainnet
The unique identifier of the member that owns this node.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
", "location": "querystring", "locationName": "memberId" }, "NodeId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the node.
", "location": "uri", "locationName": "nodeId" } } }, "DeleteNodeOutput": { "type": "structure", "members": {} }, "DescriptionString": { "type": "string", "max": 128 }, "Edition": { "type": "string", "enum": [ "STARTER", "STANDARD" ] }, "Enabled": { "type": "boolean", "box": true }, "Framework": { "type": "string", "enum": [ "HYPERLEDGER_FABRIC", "ETHEREUM" ] }, "FrameworkVersionString": { "type": "string", "max": 8, "min": 1 }, "GetAccessorInput": { "type": "structure", "required": [ "AccessorId" ], "members": { "AccessorId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the accessor.
", "location": "uri", "locationName": "AccessorId" } } }, "GetAccessorOutput": { "type": "structure", "members": { "Accessor": { "shape": "Accessor", "documentation": "The properties of the accessor.
" } } }, "GetMemberInput": { "type": "structure", "required": [ "NetworkId", "MemberId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network to which the member belongs.
", "location": "uri", "locationName": "networkId" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member.
", "location": "uri", "locationName": "memberId" } } }, "GetMemberOutput": { "type": "structure", "members": { "Member": { "shape": "Member", "documentation": "The properties of a member.
" } } }, "GetNetworkInput": { "type": "structure", "required": [ "NetworkId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network to get information about.
", "location": "uri", "locationName": "networkId" } } }, "GetNetworkOutput": { "type": "structure", "members": { "Network": { "shape": "Network", "documentation": "An object containing network configuration parameters.
" } } }, "GetNodeInput": { "type": "structure", "required": [ "NetworkId", "NodeId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network that the node is on.
", "location": "uri", "locationName": "networkId" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member that owns the node.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
", "location": "querystring", "locationName": "memberId" }, "NodeId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the node.
", "location": "uri", "locationName": "nodeId" } } }, "GetNodeOutput": { "type": "structure", "members": { "Node": { "shape": "Node", "documentation": "Properties of the node configuration.
" } } }, "GetProposalInput": { "type": "structure", "required": [ "NetworkId", "ProposalId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network for which the proposal is made.
", "location": "uri", "locationName": "networkId" }, "ProposalId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the proposal.
", "location": "uri", "locationName": "proposalId" } } }, "GetProposalOutput": { "type": "structure", "members": { "Proposal": { "shape": "Proposal", "documentation": "Information about a proposal.
" } } }, "InputTagMap": { "type": "map", "key": { "shape": "TagKey" }, "value": { "shape": "TagValue" }, "max": 50, "min": 0 }, "InstanceTypeString": { "type": "string" }, "Invitation": { "type": "structure", "members": { "InvitationId": { "shape": "ResourceIdString", "documentation": "The unique identifier for the invitation.
" }, "CreationDate": { "shape": "Timestamp", "documentation": "The date and time that the invitation was created.
" }, "ExpirationDate": { "shape": "Timestamp", "documentation": "The date and time that the invitation expires. This is the CreationDate
plus the ProposalDurationInHours
that is specified in the ProposalThresholdPolicy
. After this date and time, the invitee can no longer create a member and join the network using this InvitationId
.
The status of the invitation:
PENDING
- The invitee hasn't created a member to join the network, and the invitation hasn't yet expired.
ACCEPTING
- The invitee has begun creating a member, and creation hasn't yet completed.
ACCEPTED
- The invitee created a member and joined the network using the InvitationID
.
REJECTED
- The invitee rejected the invitation.
EXPIRED
- The invitee neither created a member nor rejected the invitation before the ExpirationDate
.
The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "documentation": "An invitation to an Amazon Web Services account to create a member and join the network.
Applies only to Hyperledger Fabric.
" }, "InvitationList": { "type": "list", "member": { "shape": "Invitation" } }, "InvitationStatus": { "type": "string", "enum": [ "PENDING", "ACCEPTED", "ACCEPTING", "REJECTED", "EXPIRED" ] }, "InviteAction": { "type": "structure", "required": [ "Principal" ], "members": { "Principal": { "shape": "PrincipalString", "documentation": "The Amazon Web Services account ID to invite.
" } }, "documentation": "An action to invite a specific Amazon Web Services account to create a member and join the network. The InviteAction
is carried out when a Proposal
is APPROVED
.
Applies only to Hyperledger Fabric.
" }, "InviteActionList": { "type": "list", "member": { "shape": "InviteAction" } }, "IsOwned": { "type": "boolean", "box": true }, "ListAccessorsInput": { "type": "structure", "members": { "MaxResults": { "shape": "AccessorListMaxResults", "documentation": "The maximum number of accessors to list.
", "location": "querystring", "locationName": "maxResults" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
", "location": "querystring", "locationName": "nextToken" }, "NetworkType": { "shape": "AccessorNetworkType", "documentation": "The blockchain network that the Accessor
token is created for.
Use the value ETHEREUM_MAINNET_AND_GOERLI
for all existing Accessors
tokens that were created before the networkType
property was introduced.
An array of AccessorSummary objects that contain configuration properties for each accessor.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
" } } }, "ListInvitationsInput": { "type": "structure", "members": { "MaxResults": { "shape": "ProposalListMaxResults", "documentation": "The maximum number of invitations to return.
", "location": "querystring", "locationName": "maxResults" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
", "location": "querystring", "locationName": "nextToken" } } }, "ListInvitationsOutput": { "type": "structure", "members": { "Invitations": { "shape": "InvitationList", "documentation": "The invitations for the network.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
" } } }, "ListMembersInput": { "type": "structure", "required": [ "NetworkId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network for which to list members.
", "location": "uri", "locationName": "networkId" }, "Name": { "shape": "String", "documentation": "The optional name of the member to list.
", "location": "querystring", "locationName": "name" }, "Status": { "shape": "MemberStatus", "documentation": "An optional status specifier. If provided, only members currently in this status are listed.
", "location": "querystring", "locationName": "status" }, "IsOwned": { "shape": "IsOwned", "documentation": "An optional Boolean value. If provided, the request is limited either to members that the current Amazon Web Services account owns (true
) or that other Amazon Web Services accountsn own (false
). If omitted, all members are listed.
The maximum number of members to return in the request.
", "location": "querystring", "locationName": "maxResults" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
", "location": "querystring", "locationName": "nextToken" } } }, "ListMembersOutput": { "type": "structure", "members": { "Members": { "shape": "MemberSummaryList", "documentation": "An array of MemberSummary
objects. Each object contains details about a network member.
The pagination token that indicates the next set of results to retrieve.
" } } }, "ListNetworksInput": { "type": "structure", "members": { "Name": { "shape": "String", "documentation": "The name of the network.
", "location": "querystring", "locationName": "name" }, "Framework": { "shape": "Framework", "documentation": "An optional framework specifier. If provided, only networks of this framework type are listed.
", "location": "querystring", "locationName": "framework" }, "Status": { "shape": "NetworkStatus", "documentation": "An optional status specifier. If provided, only networks currently in this status are listed.
Applies only to Hyperledger Fabric.
", "location": "querystring", "locationName": "status" }, "MaxResults": { "shape": "NetworkListMaxResults", "documentation": "The maximum number of networks to list.
", "location": "querystring", "locationName": "maxResults" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
", "location": "querystring", "locationName": "nextToken" } } }, "ListNetworksOutput": { "type": "structure", "members": { "Networks": { "shape": "NetworkSummaryList", "documentation": "An array of NetworkSummary
objects that contain configuration properties for each network.
The pagination token that indicates the next set of results to retrieve.
" } } }, "ListNodesInput": { "type": "structure", "required": [ "NetworkId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network for which to list nodes.
", "location": "uri", "locationName": "networkId" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member who owns the nodes to list.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
", "location": "querystring", "locationName": "memberId" }, "Status": { "shape": "NodeStatus", "documentation": "An optional status specifier. If provided, only nodes currently in this status are listed.
", "location": "querystring", "locationName": "status" }, "MaxResults": { "shape": "NodeListMaxResults", "documentation": "The maximum number of nodes to list.
", "location": "querystring", "locationName": "maxResults" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
", "location": "querystring", "locationName": "nextToken" } } }, "ListNodesOutput": { "type": "structure", "members": { "Nodes": { "shape": "NodeSummaryList", "documentation": "An array of NodeSummary
objects that contain configuration properties for each node.
The pagination token that indicates the next set of results to retrieve.
" } } }, "ListProposalVotesInput": { "type": "structure", "required": [ "NetworkId", "ProposalId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network.
", "location": "uri", "locationName": "networkId" }, "ProposalId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the proposal.
", "location": "uri", "locationName": "proposalId" }, "MaxResults": { "shape": "ProposalListMaxResults", "documentation": "The maximum number of votes to return.
", "location": "querystring", "locationName": "maxResults" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
", "location": "querystring", "locationName": "nextToken" } } }, "ListProposalVotesOutput": { "type": "structure", "members": { "ProposalVotes": { "shape": "ProposalVoteList", "documentation": "The list of votes.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
" } } }, "ListProposalsInput": { "type": "structure", "required": [ "NetworkId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network.
", "location": "uri", "locationName": "networkId" }, "MaxResults": { "shape": "ProposalListMaxResults", "documentation": "The maximum number of proposals to return.
", "location": "querystring", "locationName": "maxResults" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
", "location": "querystring", "locationName": "nextToken" } } }, "ListProposalsOutput": { "type": "structure", "members": { "Proposals": { "shape": "ProposalSummaryList", "documentation": "The summary of each proposal made on the network.
" }, "NextToken": { "shape": "PaginationToken", "documentation": "The pagination token that indicates the next set of results to retrieve.
" } } }, "ListTagsForResourceRequest": { "type": "structure", "required": [ "ResourceArn" ], "members": { "ResourceArn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "location": "uri", "locationName": "resourceArn" } } }, "ListTagsForResourceResponse": { "type": "structure", "members": { "Tags": { "shape": "OutputTagMap", "documentation": "The tags assigned to the resource.
" } } }, "LogConfiguration": { "type": "structure", "members": { "Enabled": { "shape": "Enabled", "documentation": "Indicates whether logging is enabled.
" } }, "documentation": "A configuration for logging events.
" }, "LogConfigurations": { "type": "structure", "members": { "Cloudwatch": { "shape": "LogConfiguration", "documentation": "Parameters for publishing logs to Amazon CloudWatch Logs.
" } }, "documentation": "A collection of log configurations.
" }, "Member": { "type": "structure", "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network to which the member belongs.
" }, "Id": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member.
" }, "Name": { "shape": "NetworkMemberNameString", "documentation": "The name of the member.
" }, "Description": { "shape": "DescriptionString", "documentation": "An optional description for the member.
" }, "FrameworkAttributes": { "shape": "MemberFrameworkAttributes", "documentation": "Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.
" }, "LogPublishingConfiguration": { "shape": "MemberLogPublishingConfiguration", "documentation": "Configuration properties for logging events associated with a member.
" }, "Status": { "shape": "MemberStatus", "documentation": "The status of a member.
CREATING
- The Amazon Web Services account is in the process of creating a member.
AVAILABLE
- The member has been created and can participate in the network.
CREATE_FAILED
- The Amazon Web Services account attempted to create a member and creation failed.
UPDATING
- The member is in the process of being updated.
DELETING
- The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED
PROPOSAL
to remove the member.
DELETED
- The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED
PROPOSAL
to remove the member.
INACCESSIBLE_ENCRYPTION_KEY
- The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.
The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.
The date and time that the member was created.
" }, "Tags": { "shape": "OutputTagMap", "documentation": "Tags assigned to the member. Tags consist of a key and optional value.
For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" }, "KmsKeyArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the member uses for encryption at rest. If the value of this parameter is \"AWS Owned KMS Key\"
, the member uses an Amazon Web Services owned KMS key for encryption. This parameter is inherited by the nodes that this member owns.
For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
" } }, "documentation": "Member configuration properties.
Applies only to Hyperledger Fabric.
" }, "MemberConfiguration": { "type": "structure", "required": [ "Name", "FrameworkConfiguration" ], "members": { "Name": { "shape": "NetworkMemberNameString", "documentation": "The name of the member.
" }, "Description": { "shape": "DescriptionString", "documentation": "An optional description of the member.
" }, "FrameworkConfiguration": { "shape": "MemberFrameworkConfiguration", "documentation": "Configuration properties of the blockchain framework relevant to the member.
" }, "LogPublishingConfiguration": { "shape": "MemberLogPublishingConfiguration", "documentation": "Configuration properties for logging events associated with a member of a Managed Blockchain network.
" }, "Tags": { "shape": "InputTagMap", "documentation": "Tags assigned to the member. Tags consist 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.
" }, "KmsKeyArn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) to use for encryption at rest in the member. This parameter is inherited by any nodes that this member creates. For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
Use one of the following options to specify this parameter:
Undefined or empty string - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf.
A valid symmetric customer managed KMS key - Use the specified KMS key in your account that you create, own, and manage.
Amazon Managed Blockchain doesn't support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.
The following is an example of a KMS key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Configuration properties of the member.
Applies only to Hyperledger Fabric.
" }, "MemberFabricAttributes": { "type": "structure", "members": { "AdminUsername": { "shape": "UsernameString", "documentation": "The user name for the initial administrator user for the member.
" }, "CaEndpoint": { "shape": "String", "documentation": "The endpoint used to access the member's certificate authority.
" } }, "documentation": "Attributes of Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.
" }, "MemberFabricConfiguration": { "type": "structure", "required": [ "AdminUsername", "AdminPassword" ], "members": { "AdminUsername": { "shape": "UsernameString", "documentation": "The user name for the member's initial administrative user.
" }, "AdminPassword": { "shape": "PasswordString", "documentation": "The password for the member's initial administrative user. The AdminPassword
must be at least 8 characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quotation mark (‘), a double quotation marks (“), a forward slash(/), a backward slash(\\), @, or a space.
Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network that is using the Hyperledger Fabric framework.
" }, "MemberFabricLogPublishingConfiguration": { "type": "structure", "members": { "CaLogs": { "shape": "LogConfigurations", "documentation": "Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.
" } }, "documentation": "Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
" }, "MemberFrameworkAttributes": { "type": "structure", "members": { "Fabric": { "shape": "MemberFabricAttributes", "documentation": "Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger Fabric.
" } }, "documentation": "Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.
" }, "MemberFrameworkConfiguration": { "type": "structure", "members": { "Fabric": { "shape": "MemberFabricConfiguration", "documentation": "Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.
" } }, "documentation": "Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses.
" }, "MemberListMaxResults": { "type": "integer", "box": true, "max": 20, "min": 1 }, "MemberLogPublishingConfiguration": { "type": "structure", "members": { "Fabric": { "shape": "MemberFabricLogPublishingConfiguration", "documentation": "Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
" } }, "documentation": "Configuration properties for logging events associated with a member of a Managed Blockchain network.
" }, "MemberStatus": { "type": "string", "enum": [ "CREATING", "AVAILABLE", "CREATE_FAILED", "UPDATING", "DELETING", "DELETED", "INACCESSIBLE_ENCRYPTION_KEY" ] }, "MemberSummary": { "type": "structure", "members": { "Id": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member.
" }, "Name": { "shape": "NetworkMemberNameString", "documentation": "The name of the member.
" }, "Description": { "shape": "DescriptionString", "documentation": "An optional description of the member.
" }, "Status": { "shape": "MemberStatus", "documentation": "The status of the member.
CREATING
- The Amazon Web Services account is in the process of creating a member.
AVAILABLE
- The member has been created and can participate in the network.
CREATE_FAILED
- The Amazon Web Services account attempted to create a member and creation failed.
UPDATING
- The member is in the process of being updated.
DELETING
- The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED
PROPOSAL
to remove the member.
DELETED
- The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED
PROPOSAL
to remove the member.
INACCESSIBLE_ENCRYPTION_KEY
- The member is impaired and might not function as expected because it cannot access the specified customer managed key in Key Management Service (KMS) for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.
The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.
The date and time that the member was created.
" }, "IsOwned": { "shape": "IsOwned", "documentation": "An indicator of whether the member is owned by your Amazon Web Services account or a different Amazon Web Services account.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "documentation": "A summary of configuration properties for a member.
Applies only to Hyperledger Fabric.
" }, "MemberSummaryList": { "type": "list", "member": { "shape": "MemberSummary" } }, "NameString": { "type": "string", "max": 64, "min": 1, "pattern": ".*\\S.*" }, "Network": { "type": "structure", "members": { "Id": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network.
" }, "Name": { "shape": "NameString", "documentation": "The name of the network.
" }, "Description": { "shape": "DescriptionString", "documentation": "Attributes of the blockchain framework for the network.
" }, "Framework": { "shape": "Framework", "documentation": "The blockchain framework that the network uses.
" }, "FrameworkVersion": { "shape": "FrameworkVersionString", "documentation": "The version of the blockchain framework that the network uses.
" }, "FrameworkAttributes": { "shape": "NetworkFrameworkAttributes", "documentation": "Attributes of the blockchain framework that the network uses.
" }, "VpcEndpointServiceName": { "shape": "String", "documentation": "The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service name to create a VPC endpoint to access network resources.
" }, "VotingPolicy": { "shape": "VotingPolicy", "documentation": "The voting rules that the network uses to decide if a proposal is accepted.
" }, "Status": { "shape": "NetworkStatus", "documentation": "The current status of the network.
" }, "CreationDate": { "shape": "Timestamp", "documentation": "The date and time that the network was created.
" }, "Tags": { "shape": "OutputTagMap", "documentation": "Tags assigned to the network. 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.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "documentation": "Network configuration properties.
" }, "NetworkEthereumAttributes": { "type": "structure", "members": { "ChainId": { "shape": "String", "documentation": "The Ethereum CHAIN_ID
associated with the Ethereum network. Chain IDs are as follows:
mainnet = 1
Attributes of Ethereum for a network.
" }, "NetworkFabricAttributes": { "type": "structure", "members": { "OrderingServiceEndpoint": { "shape": "String", "documentation": "The endpoint of the ordering service for the network.
" }, "Edition": { "shape": "Edition", "documentation": "The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing.
" } }, "documentation": "Attributes of Hyperledger Fabric for a network.
" }, "NetworkFabricConfiguration": { "type": "structure", "required": [ "Edition" ], "members": { "Edition": { "shape": "Edition", "documentation": "The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.
" } }, "documentation": "Hyperledger Fabric configuration properties for the network.
" }, "NetworkFrameworkAttributes": { "type": "structure", "members": { "Fabric": { "shape": "NetworkFabricAttributes", "documentation": "Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric.
" }, "Ethereum": { "shape": "NetworkEthereumAttributes", "documentation": "Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network.
" } }, "documentation": "Attributes relevant to the network for the blockchain framework that the network uses.
" }, "NetworkFrameworkConfiguration": { "type": "structure", "members": { "Fabric": { "shape": "NetworkFabricConfiguration", "documentation": "Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric.
" } }, "documentation": "Configuration properties relevant to the network for the blockchain framework that the network uses.
" }, "NetworkListMaxResults": { "type": "integer", "box": true, "max": 10, "min": 1 }, "NetworkMemberNameString": { "type": "string", "max": 64, "min": 1, "pattern": "^(?!-|[0-9])(?!.*-$)(?!.*?--)[a-zA-Z0-9-]+$" }, "NetworkStatus": { "type": "string", "enum": [ "CREATING", "AVAILABLE", "CREATE_FAILED", "DELETING", "DELETED" ] }, "NetworkSummary": { "type": "structure", "members": { "Id": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network.
" }, "Name": { "shape": "NameString", "documentation": "The name of the network.
" }, "Description": { "shape": "DescriptionString", "documentation": "An optional description of the network.
" }, "Framework": { "shape": "Framework", "documentation": "The blockchain framework that the network uses.
" }, "FrameworkVersion": { "shape": "FrameworkVersionString", "documentation": "The version of the blockchain framework that the network uses.
" }, "Status": { "shape": "NetworkStatus", "documentation": "The current status of the network.
" }, "CreationDate": { "shape": "Timestamp", "documentation": "The date and time that the network was created.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "documentation": "A summary of network configuration properties.
" }, "NetworkSummaryList": { "type": "list", "member": { "shape": "NetworkSummary" } }, "Node": { "type": "structure", "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network that the node is on.
" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member to which the node belongs.
Applies only to Hyperledger Fabric.
" }, "Id": { "shape": "ResourceIdString", "documentation": "The unique identifier of the node.
" }, "InstanceType": { "shape": "InstanceTypeString", "documentation": "The instance type of the node.
" }, "AvailabilityZone": { "shape": "AvailabilityZoneString", "documentation": "The Availability Zone in which the node exists. Required for Ethereum nodes.
" }, "FrameworkAttributes": { "shape": "NodeFrameworkAttributes", "documentation": "Attributes of the blockchain framework being used.
" }, "LogPublishingConfiguration": { "shape": "NodeLogPublishingConfiguration", "documentation": "Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.
" }, "StateDB": { "shape": "StateDBType", "documentation": "The state database that the node uses. Values are LevelDB
or CouchDB
.
Applies only to Hyperledger Fabric.
" }, "Status": { "shape": "NodeStatus", "documentation": "The status of the node.
CREATING
- The Amazon Web Services account is in the process of creating a node.
AVAILABLE
- The node has been created and can participate in the network.
UNHEALTHY
- The node is impaired and might not function as expected. Amazon Managed Blockchain automatically finds nodes in this state and tries to recover them. If a node is recoverable, it returns to AVAILABLE
. Otherwise, it moves to FAILED
status.
CREATE_FAILED
- The Amazon Web Services account attempted to create a node and creation failed.
UPDATING
- The node is in the process of being updated.
DELETING
- The node is in the process of being deleted.
DELETED
- The node can no longer participate on the network.
FAILED
- The node is no longer functional, cannot be recovered, and must be deleted.
INACCESSIBLE_ENCRYPTION_KEY
- The node is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.
The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the node resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.
The date and time that the node was created.
" }, "Tags": { "shape": "OutputTagMap", "documentation": "Tags assigned to the node. 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.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" }, "KmsKeyArn": { "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the node uses for encryption at rest. If the value of this parameter is \"AWS Owned KMS Key\"
, the node uses an Amazon Web Services owned KMS key for encryption. The node inherits this parameter from the member that it belongs to.
For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.
Applies only to Hyperledger Fabric.
" } }, "documentation": "Configuration properties of a node.
" }, "NodeConfiguration": { "type": "structure", "required": [ "InstanceType" ], "members": { "InstanceType": { "shape": "InstanceTypeString", "documentation": "The Amazon Managed Blockchain instance type for the node.
" }, "AvailabilityZone": { "shape": "AvailabilityZoneString", "documentation": "The Availability Zone in which the node exists. Required for Ethereum nodes.
" }, "LogPublishingConfiguration": { "shape": "NodeLogPublishingConfiguration", "documentation": "Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.
" }, "StateDB": { "shape": "StateDBType", "documentation": "The state database that the node uses. Values are LevelDB
or CouchDB
. When using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or later, the default is CouchDB
.
Applies only to Hyperledger Fabric.
" } }, "documentation": "Configuration properties of a node.
" }, "NodeEthereumAttributes": { "type": "structure", "members": { "HttpEndpoint": { "shape": "String", "documentation": "The endpoint on which the Ethereum node listens to run Ethereum API methods over HTTP connections from a client. Use this endpoint in client code for smart contracts when using an HTTP connection. Connections to this endpoint are authenticated using Signature Version 4.
" }, "WebSocketEndpoint": { "shape": "String", "documentation": "The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over WebSocket connections from a client. Use this endpoint in client code for smart contracts when using a WebSocket connection. Connections to this endpoint are authenticated using Signature Version 4.
" } }, "documentation": "Attributes of an Ethereum node.
" }, "NodeFabricAttributes": { "type": "structure", "members": { "PeerEndpoint": { "shape": "String", "documentation": "The endpoint that identifies the peer node for all services except peer channel-based event services.
" }, "PeerEventEndpoint": { "shape": "String", "documentation": "The endpoint that identifies the peer node for peer channel-based event services.
" } }, "documentation": "Attributes of Hyperledger Fabric for a peer node on a Hyperledger Fabric network on Managed Blockchain.
" }, "NodeFabricLogPublishingConfiguration": { "type": "structure", "members": { "ChaincodeLogs": { "shape": "LogConfigurations", "documentation": "Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.
" }, "PeerLogs": { "shape": "LogConfigurations", "documentation": "Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.
" } }, "documentation": "Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.
" }, "NodeFrameworkAttributes": { "type": "structure", "members": { "Fabric": { "shape": "NodeFabricAttributes", "documentation": "Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.
" }, "Ethereum": { "shape": "NodeEthereumAttributes", "documentation": "Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum.
" } }, "documentation": "Attributes relevant to a node on a Managed Blockchain network for the blockchain framework that the network uses.
" }, "NodeListMaxResults": { "type": "integer", "box": true, "max": 20, "min": 1 }, "NodeLogPublishingConfiguration": { "type": "structure", "members": { "Fabric": { "shape": "NodeFabricLogPublishingConfiguration", "documentation": "Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.
" } }, "documentation": "Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.
" }, "NodeStatus": { "type": "string", "enum": [ "CREATING", "AVAILABLE", "UNHEALTHY", "CREATE_FAILED", "UPDATING", "DELETING", "DELETED", "FAILED", "INACCESSIBLE_ENCRYPTION_KEY" ] }, "NodeSummary": { "type": "structure", "members": { "Id": { "shape": "ResourceIdString", "documentation": "The unique identifier of the node.
" }, "Status": { "shape": "NodeStatus", "documentation": "The status of the node.
" }, "CreationDate": { "shape": "Timestamp", "documentation": "The date and time that the node was created.
" }, "AvailabilityZone": { "shape": "AvailabilityZoneString", "documentation": "The Availability Zone in which the node exists.
" }, "InstanceType": { "shape": "InstanceTypeString", "documentation": "The EC2 instance type for the node.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "documentation": "A summary of configuration properties for a node.
" }, "NodeSummaryList": { "type": "list", "member": { "shape": "NodeSummary" } }, "OutputTagMap": { "type": "map", "key": { "shape": "TagKey" }, "value": { "shape": "TagValue" }, "max": 200, "min": 0 }, "PaginationToken": { "type": "string", "max": 128 }, "PasswordString": { "type": "string", "max": 32, "min": 8, "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?!.*[@'\\\\\"/])[a-zA-Z0-9\\S]*$", "sensitive": true }, "PrincipalString": { "type": "string" }, "Proposal": { "type": "structure", "members": { "ProposalId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the proposal.
" }, "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network for which the proposal is made.
" }, "Description": { "shape": "DescriptionString", "documentation": "The description of the proposal.
" }, "Actions": { "shape": "ProposalActions", "documentation": "The actions to perform on the network if the proposal is APPROVED
.
The unique identifier of the member that created the proposal.
" }, "ProposedByMemberName": { "shape": "NetworkMemberNameString", "documentation": "The name of the member that created the proposal.
" }, "Status": { "shape": "ProposalStatus", "documentation": "The status of the proposal. Values are as follows:
IN_PROGRESS
- The proposal is active and open for member voting.
APPROVED
- The proposal was approved with sufficient YES
votes among members according to the VotingPolicy
specified for the Network
. The specified proposal actions are carried out.
REJECTED
- The proposal was rejected with insufficient YES
votes among members according to the VotingPolicy
specified for the Network
. The specified ProposalActions
aren't carried out.
EXPIRED
- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions
aren't carried out.
ACTION_FAILED
- One or more of the specified ProposalActions
in a proposal that was approved couldn't be completed because of an error. The ACTION_FAILED
status occurs even if only one ProposalAction fails and other actions are successful.
The date and time that the proposal was created.
" }, "ExpirationDate": { "shape": "Timestamp", "documentation": " The date and time that the proposal expires. This is the CreationDate
plus the ProposalDurationInHours
that is specified in the ProposalThresholdPolicy
. After this date and time, if members haven't cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED
and Actions
aren't carried out.
The current total of YES
votes cast on the proposal by members.
The current total of NO
votes cast on the proposal by members.
The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of YES
votes and NO
votes.
Tags assigned to the proposal. 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.
" }, "Arn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "documentation": "Properties of a proposal on a Managed Blockchain network.
Applies only to Hyperledger Fabric.
" }, "ProposalActions": { "type": "structure", "members": { "Invitations": { "shape": "InviteActionList", "documentation": " The actions to perform for an APPROVED
proposal to invite an Amazon Web Services account to create a member and join the network.
The actions to perform for an APPROVED
proposal to remove a member from the network, which deletes the member and all associated member resources from the network.
The actions to carry out if a proposal is APPROVED
.
Applies only to Hyperledger Fabric.
" }, "ProposalDurationInt": { "type": "integer", "box": true, "max": 168, "min": 1 }, "ProposalListMaxResults": { "type": "integer", "box": true, "max": 100, "min": 1 }, "ProposalStatus": { "type": "string", "enum": [ "IN_PROGRESS", "APPROVED", "REJECTED", "EXPIRED", "ACTION_FAILED" ] }, "ProposalSummary": { "type": "structure", "members": { "ProposalId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the proposal.
" }, "Description": { "shape": "DescriptionString", "documentation": "The description of the proposal.
" }, "ProposedByMemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member that created the proposal.
" }, "ProposedByMemberName": { "shape": "NetworkMemberNameString", "documentation": "The name of the member that created the proposal.
" }, "Status": { "shape": "ProposalStatus", "documentation": "The status of the proposal. Values are as follows:
IN_PROGRESS
- The proposal is active and open for member voting.
APPROVED
- The proposal was approved with sufficient YES
votes among members according to the VotingPolicy
specified for the Network
. The specified proposal actions are carried out.
REJECTED
- The proposal was rejected with insufficient YES
votes among members according to the VotingPolicy
specified for the Network
. The specified ProposalActions
aren't carried out.
EXPIRED
- Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions
aren't carried out.
ACTION_FAILED
- One or more of the specified ProposalActions
in a proposal that was approved couldn't be completed because of an error.
The date and time that the proposal was created.
" }, "ExpirationDate": { "shape": "Timestamp", "documentation": " The date and time that the proposal expires. This is the CreationDate
plus the ProposalDurationInHours
that is specified in the ProposalThresholdPolicy
. After this date and time, if members haven't cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED
and Actions
aren't carried out.
The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
" } }, "documentation": "Properties of a proposal.
Applies only to Hyperledger Fabric.
" }, "ProposalSummaryList": { "type": "list", "member": { "shape": "ProposalSummary" } }, "ProposalVoteList": { "type": "list", "member": { "shape": "VoteSummary" } }, "RejectInvitationInput": { "type": "structure", "required": [ "InvitationId" ], "members": { "InvitationId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the invitation to reject.
", "location": "uri", "locationName": "invitationId" } } }, "RejectInvitationOutput": { "type": "structure", "members": {} }, "RemoveAction": { "type": "structure", "required": [ "MemberId" ], "members": { "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member to remove.
" } }, "documentation": "An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED
. The member and all associated resources are deleted from the network.
Applies only to Hyperledger Fabric.
" }, "RemoveActionList": { "type": "list", "member": { "shape": "RemoveAction" } }, "ResourceIdString": { "type": "string", "max": 32, "min": 1 }, "StateDBType": { "type": "string", "enum": [ "LevelDB", "CouchDB" ] }, "String": { "type": "string" }, "TagKey": { "type": "string", "max": 128, "min": 1 }, "TagKeyList": { "type": "list", "member": { "shape": "TagKey" }, "max": 200, "min": 0 }, "TagResourceRequest": { "type": "structure", "required": [ "ResourceArn", "Tags" ], "members": { "ResourceArn": { "shape": "ArnString", "documentation": "The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "location": "uri", "locationName": "resourceArn" }, "Tags": { "shape": "InputTagMap", "documentation": "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.
The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
", "location": "uri", "locationName": "resourceArn" }, "TagKeys": { "shape": "TagKeyList", "documentation": "The tag keys.
", "location": "querystring", "locationName": "tagKeys" } } }, "UntagResourceResponse": { "type": "structure", "members": {} }, "UpdateMemberInput": { "type": "structure", "required": [ "NetworkId", "MemberId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the Managed Blockchain network to which the member belongs.
", "location": "uri", "locationName": "networkId" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member.
", "location": "uri", "locationName": "memberId" }, "LogPublishingConfiguration": { "shape": "MemberLogPublishingConfiguration", "documentation": "Configuration properties for publishing to Amazon CloudWatch Logs.
" } } }, "UpdateMemberOutput": { "type": "structure", "members": {} }, "UpdateNodeInput": { "type": "structure", "required": [ "NetworkId", "NodeId" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network that the node is on.
", "location": "uri", "locationName": "networkId" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member that owns the node.
Applies only to Hyperledger Fabric.
" }, "NodeId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the node.
", "location": "uri", "locationName": "nodeId" }, "LogPublishingConfiguration": { "shape": "NodeLogPublishingConfiguration", "documentation": "Configuration properties for publishing to Amazon CloudWatch Logs.
" } } }, "UpdateNodeOutput": { "type": "structure", "members": {} }, "UsernameString": { "type": "string", "max": 16, "min": 1, "pattern": "^[a-zA-Z][a-zA-Z0-9]*$" }, "VoteCount": { "type": "integer", "box": true }, "VoteOnProposalInput": { "type": "structure", "required": [ "NetworkId", "ProposalId", "VoterMemberId", "Vote" ], "members": { "NetworkId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the network.
", "location": "uri", "locationName": "networkId" }, "ProposalId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the proposal.
", "location": "uri", "locationName": "proposalId" }, "VoterMemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member casting the vote.
" }, "Vote": { "shape": "VoteValue", "documentation": "The value of the vote.
" } } }, "VoteOnProposalOutput": { "type": "structure", "members": {} }, "VoteSummary": { "type": "structure", "members": { "Vote": { "shape": "VoteValue", "documentation": " The vote value, either YES
or NO
.
The name of the member that cast the vote.
" }, "MemberId": { "shape": "ResourceIdString", "documentation": "The unique identifier of the member that cast the vote.
" } }, "documentation": "Properties of an individual vote that a member cast for a proposal.
Applies only to Hyperledger Fabric.
" }, "VoteValue": { "type": "string", "enum": [ "YES", "NO" ] }, "VotingPolicy": { "type": "structure", "members": { "ApprovalThresholdPolicy": { "shape": "ApprovalThresholdPolicy", "documentation": "Defines the rules for the network for voting on proposals, such as the percentage of YES
votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.
The voting rules for the network to decide if a proposal is accepted
Applies only to Hyperledger Fabric.
" } }, "documentation": "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.
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 CreateMember
and DeleteMember
don't apply to Ethereum.
The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.
" }