openapi: 3.0.0 info: version: '2018-09-24' x-release: v4 title: Amazon Managed Blockchain description: '
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.
' x-logo: url: 'https://twitter.com/awscloud/profile_image?size=original' backgroundColor: '#FFFFFF' termsOfService: 'https://aws.amazon.com/service-terms/' contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: 'https://github.com/mermade/aws2openapi' x-twitter: PermittedSoc license: name: Apache 2.0 License url: 'http://www.apache.org/licenses/' x-providerName: amazonaws.com x-serviceName: managedblockchain x-aws-signingName: managedblockchain x-origin: - contentType: application/json url: 'https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/managedblockchain-2018-09-24.normal.json' converter: url: 'https://github.com/mermade/aws2openapi' version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: 'https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct' x-apisguru-categories: - cloud x-preferred: true externalDocs: description: Amazon Web Services documentation url: 'https://docs.aws.amazon.com/managedblockchain/' servers: - url: 'http://managedblockchain.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The ManagedBlockchain multi-region endpoint - url: 'https://managedblockchain.{region}.amazonaws.com' variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The ManagedBlockchain multi-region endpoint - url: 'http://managedblockchain.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The ManagedBlockchain endpoint for China (Beijing) and China (Ningxia) - url: 'https://managedblockchain.{region}.amazonaws.com.cn' variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The ManagedBlockchain endpoint for China (Beijing) and China (Ningxia) x-hasEquivalentPaths: true paths: /accessors: post: operationId: CreateAccessor description: Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor contains information required for token based access to your Ethereum nodes. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateAccessorOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '486': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ClientRequestToken - AccessorType properties: ClientRequestToken: description: '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.' type: string minLength: 1 maxLength: 64 AccessorType: description: '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.
' type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' summary: Amazon Managed Blockchain Create Accessor parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListAccessors description: 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. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListAccessorsOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: maxResults in: query required: false description: ' The maximum number of accessors to list.' schema: type: integer minimum: 1 maximum: 50 - name: nextToken in: query required: false description: ' The pagination token that indicates the next set of results to retrieve. ' schema: type: string maxLength: 128 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Managed Blockchain List Accessors '/networks/{networkId}/members': post: operationId: CreateMember description:Creates a member within a Managed Blockchain network.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateMemberOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '484': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' '487': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '488': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' parameters: - name: networkId in: path required: true description: The unique identifier of the network in which the member is created. schema: type: string minLength: 1 maxLength: 32 requestBody: required: true content: application/json: schema: type: object required: - ClientRequestToken - InvitationId - MemberConfiguration properties: ClientRequestToken: description: '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.' type: string minLength: 1 maxLength: 64 InvitationId: description: The unique identifier of the invitation that is sent to the member to join the network. type: string minLength: 1 maxLength: 32 MemberConfiguration: description:Configuration properties of the member.
Applies only to Hyperledger Fabric.
type: object properties: Name: allOf: - $ref: '#/components/schemas/NetworkMemberNameString' - description: The name of the member. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: An optional description of the member. FrameworkConfiguration: allOf: - $ref: '#/components/schemas/MemberFrameworkConfiguration' - description: Configuration properties of the blockchain framework relevant to the member. LogPublishingConfiguration: allOf: - $ref: '#/components/schemas/MemberLogPublishingConfiguration' - description: Configuration properties for logging events associated with a member of a Managed Blockchain network. Tags: allOf: - $ref: '#/components/schemas/InputTagMap' - description: '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: allOf: - $ref: '#/components/schemas/ArnString' - description: '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
Returns a list of the members in a network and properties of their configurations.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListMembersOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the network for which to list members. schema: type: string minLength: 1 maxLength: 32 - name: name in: query required: false description: The optional name of the member to list. schema: type: string - name: status in: query required: false description: 'An optional status specifier. If provided, only members currently in this status are listed.' schema: type: string enum: - CREATING - AVAILABLE - CREATE_FAILED - UPDATING - DELETING - DELETED - INACCESSIBLE_ENCRYPTION_KEY - name: isOwned in: query required: false description: '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.'
schema:
type: boolean
- name: maxResults
in: query
required: false
description: The maximum number of members to return in the request.
schema:
type: integer
minimum: 1
maximum: 20
- name: nextToken
in: query
required: false
description: The pagination token that indicates the next set of results to retrieve.
schema:
type: string
maxLength: 128
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
summary: Amazon Managed Blockchain List Members
/networks:
post:
operationId: CreateNetwork
description: Creates a new blockchain network using Amazon Managed Blockchain.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateNetworkOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '486': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' parameters: [] requestBody: required: true content: application/json: schema: type: object required: - ClientRequestToken - Name - Framework - FrameworkVersion - VotingPolicy - MemberConfiguration properties: ClientRequestToken: description: '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. ' type: string minLength: 1 maxLength: 64 Name: description: The name of the network. type: string pattern: .*\S.* minLength: 1 maxLength: 64 Description: description: An optional description for the network. type: string maxLength: 128 Framework: description: The blockchain framework that the network uses. type: string enum: - HYPERLEDGER_FABRIC - ETHEREUM FrameworkVersion: description: The version of the blockchain framework that the network uses. type: string minLength: 1 maxLength: 8 FrameworkConfiguration: description: ' Configuration properties relevant to the network for the blockchain framework that the network uses. ' type: object properties: Fabric: allOf: - $ref: '#/components/schemas/NetworkFabricConfiguration' - description: ' Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric. ' VotingPolicy: description:The voting rules for the network to decide if a proposal is accepted
Applies only to Hyperledger Fabric.
type: object properties: ApprovalThresholdPolicy: allOf: - $ref: '#/components/schemas/ApprovalThresholdPolicy' - description: 'Defines the rules for the network for voting on proposals, such as the percentage ofYES 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.'
MemberConfiguration:
description: Configuration properties of the member.
Applies only to Hyperledger Fabric.
type: object properties: Name: allOf: - $ref: '#/components/schemas/NetworkMemberNameString' - description: The name of the member. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: An optional description of the member. FrameworkConfiguration: allOf: - $ref: '#/components/schemas/MemberFrameworkConfiguration' - description: Configuration properties of the blockchain framework relevant to the member. LogPublishingConfiguration: allOf: - $ref: '#/components/schemas/MemberLogPublishingConfiguration' - description: Configuration properties for logging events associated with a member of a Managed Blockchain network. Tags: allOf: - $ref: '#/components/schemas/InputTagMap' - description: '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: allOf: - $ref: '#/components/schemas/ArnString' - description: '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
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.
' type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' summary: Amazon Managed Blockchain Create Network parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListNetworks description:Returns information about the networks in which the current Amazon Web Services account participates.
Applies to Hyperledger Fabric and Ethereum.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListNetworksOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: name in: query required: false description: The name of the network. schema: type: string - name: framework in: query required: false description: 'An optional framework specifier. If provided, only networks of this framework type are listed.' schema: type: string enum: - HYPERLEDGER_FABRIC - ETHEREUM - name: status in: query required: false description: 'An optional status specifier. If provided, only networks currently in this status are listed.
Applies only to Hyperledger Fabric.
' schema: type: string enum: - CREATING - AVAILABLE - CREATE_FAILED - DELETING - DELETED - name: maxResults in: query required: false description: The maximum number of networks to list. schema: type: integer minimum: 1 maximum: 10 - name: nextToken in: query required: false description: The pagination token that indicates the next set of results to retrieve. schema: type: string maxLength: 128 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Managed Blockchain List Networks '/networks/{networkId}/nodes': post: operationId: CreateNode description:Creates a node on the specified blockchain network.
Applies to Hyperledger Fabric and Ethereum.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateNodeOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceAlreadyExistsException content: application/json: schema: $ref: '#/components/schemas/ResourceAlreadyExistsException' '484': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' '485': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '486': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' '487': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '488': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' parameters: - name: networkId in: path required: true description: 'The unique identifier of the network for the node.
Ethereum public networks have the following NetworkIds:
n-ethereum-mainnet
n-ethereum-goerli
n-ethereum-rinkeby
The unique identifier of the member that owns this node.
Applies only to Hyperledger Fabric.
type: string minLength: 1 maxLength: 32 NodeConfiguration: description: Configuration properties of a node. type: object properties: InstanceType: allOf: - $ref: '#/components/schemas/InstanceTypeString' - description: The Amazon Managed Blockchain instance type for the node. AvailabilityZone: allOf: - $ref: '#/components/schemas/AvailabilityZoneString' - description: 'The Availability Zone in which the node exists. Required for Ethereum nodes. ' LogPublishingConfiguration: allOf: - $ref: '#/components/schemas/NodeLogPublishingConfiguration' - description: 'Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain. ' StateDB: allOf: - $ref: '#/components/schemas/StateDBType' - description: '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.
' Tags: description: '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.
' type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' summary: Amazon Managed Blockchain Create Node parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListNodes description:Returns information about the nodes within a network.
Applies to Hyperledger Fabric and Ethereum.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListNodesOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the network for which to list nodes. schema: type: string minLength: 1 maxLength: 32 - name: memberId in: query required: false description:The unique identifier of the member who owns the nodes to list.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
schema: type: string minLength: 1 maxLength: 32 - name: status in: query required: false description: 'An optional status specifier. If provided, only nodes currently in this status are listed.' schema: type: string enum: - CREATING - AVAILABLE - UNHEALTHY - CREATE_FAILED - UPDATING - DELETING - DELETED - FAILED - INACCESSIBLE_ENCRYPTION_KEY - name: maxResults in: query required: false description: The maximum number of nodes to list. schema: type: integer minimum: 1 maximum: 20 - name: nextToken in: query required: false description: The pagination token that indicates the next set of results to retrieve. schema: type: string maxLength: 128 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Managed Blockchain List Nodes '/networks/{networkId}/proposals': post: operationId: CreateProposal description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateProposalOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '486': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' parameters: - name: networkId in: path required: true description: ' The unique identifier of the network for which the proposal is made.' schema: type: string minLength: 1 maxLength: 32 requestBody: required: true content: application/json: schema: type: object required: - ClientRequestToken - MemberId - Actions properties: ClientRequestToken: description: '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.' type: string minLength: 1 maxLength: 64 MemberId: description: 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. type: string minLength: 1 maxLength: 32 Actions: description: The actions to carry out if a proposal is APPROVED.
Applies only to Hyperledger Fabric.
type: object properties: Invitations: allOf: - $ref: '#/components/schemas/InviteActionList' - description: ' The actions to perform for anAPPROVED proposal to invite an Amazon Web Services account to create a member and join the network. '
Removals:
allOf:
- $ref: '#/components/schemas/RemoveActionList'
- description: ' 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. '
Description:
description: 'A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."'
type: string
maxLength: 128
Tags:
description: '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.
' type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' summary: Amazon Managed Blockchain Create Proposal parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: ListProposals description:Returns a list of proposals for the network.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListProposalsOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: ' The unique identifier of the network. ' schema: type: string minLength: 1 maxLength: 32 - name: maxResults in: query required: false description: ' The maximum number of proposals to return. ' schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: ' The pagination token that indicates the next set of results to retrieve. ' schema: type: string maxLength: 128 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Managed Blockchain List Proposals '/accessors/{AccessorId}': delete: operationId: DeleteAccessor description: '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, theBILLING_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).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteAccessorOutput'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
parameters:
- name: AccessorId
in: path
required: true
description: The unique identifier of the accessor.
schema:
type: string
minLength: 1
maxLength: 32
summary: Amazon Managed Blockchain Delete Accessor
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
operationId: GetAccessor
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetAccessorOutput'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
parameters:
- name: AccessorId
in: path
required: true
description: The unique identifier of the accessor.
schema:
type: string
minLength: 1
maxLength: 32
summary: Amazon Managed Blockchain Get Accessor
'/networks/{networkId}/members/{memberId}':
delete:
operationId: DeleteMember
description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteMemberOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the network from which the member is removed. schema: type: string minLength: 1 maxLength: 32 - name: memberId in: path required: true description: The unique identifier of the member to remove. schema: type: string minLength: 1 maxLength: 32 summary: Amazon Managed Blockchain Delete Member parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetMember description:Returns detailed information about a member.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetMemberOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the network to which the member belongs. schema: type: string minLength: 1 maxLength: 32 - name: memberId in: path required: true description: The unique identifier of the member. schema: type: string minLength: 1 maxLength: 32 summary: Amazon Managed Blockchain Get Member patch: operationId: UpdateMember description:Updates a member configuration with new parameters.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateMemberOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the Managed Blockchain network to which the member belongs. schema: type: string minLength: 1 maxLength: 32 - name: memberId in: path required: true description: The unique identifier of the member. schema: type: string minLength: 1 maxLength: 32 requestBody: required: true content: application/json: schema: type: object properties: LogPublishingConfiguration: description: Configuration properties for logging events associated with a member of a Managed Blockchain network. type: object properties: Fabric: allOf: - $ref: '#/components/schemas/MemberFabricLogPublishingConfiguration' - description: Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework. summary: Amazon Managed Blockchain Update Member '/networks/{networkId}/nodes/{nodeId}': delete: operationId: DeleteNode description: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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteNodeOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: 'The unique identifier of the network that the node is on.
Ethereum public networks have the following NetworkIds:
n-ethereum-mainnet
n-ethereum-goerli
n-ethereum-rinkeby
The unique identifier of the member that owns this node.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
schema: type: string minLength: 1 maxLength: 32 - name: nodeId in: path required: true description: The unique identifier of the node. schema: type: string minLength: 1 maxLength: 32 summary: Amazon Managed Blockchain Delete Node parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' get: operationId: GetNode description:Returns detailed information about a node.
Applies to Hyperledger Fabric and Ethereum.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetNodeOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the network that the node is on. schema: type: string minLength: 1 maxLength: 32 - name: memberId in: query required: false description:The unique identifier of the member that owns the node.
Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.
schema: type: string minLength: 1 maxLength: 32 - name: nodeId in: path required: true description: The unique identifier of the node. schema: type: string minLength: 1 maxLength: 32 summary: Amazon Managed Blockchain Get Node patch: operationId: UpdateNode description:Updates a node configuration with new parameters.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UpdateNodeOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the network that the node is on. schema: type: string minLength: 1 maxLength: 32 - name: nodeId in: path required: true description: The unique identifier of the node. schema: type: string minLength: 1 maxLength: 32 requestBody: required: true content: application/json: schema: type: object properties: MemberId: description:The unique identifier of the member that owns the node.
Applies only to Hyperledger Fabric.
type: string minLength: 1 maxLength: 32 LogPublishingConfiguration: description: Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain. type: object properties: Fabric: allOf: - $ref: '#/components/schemas/NodeFabricLogPublishingConfiguration' - description: 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. summary: Amazon Managed Blockchain Update Node '/networks/{networkId}': get: operationId: GetNetwork description:Returns detailed information about a network.
Applies to Hyperledger Fabric and Ethereum.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetNetworkOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the network to get information about. schema: type: string minLength: 1 maxLength: 32 summary: Amazon Managed Blockchain Get Network parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/networks/{networkId}/proposals/{proposalId}': get: operationId: GetProposal description:Returns detailed information about a proposal.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetProposalOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: The unique identifier of the network for which the proposal is made. schema: type: string minLength: 1 maxLength: 32 - name: proposalId in: path required: true description: The unique identifier of the proposal. schema: type: string minLength: 1 maxLength: 32 summary: Amazon Managed Blockchain Get Proposal parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' /invitations: get: operationId: ListInvitations description:Returns a list of all invitations for the current Amazon Web Services account.
Applies only to Hyperledger Fabric.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListInvitationsOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '484': description: ResourceLimitExceededException content: application/json: schema: $ref: '#/components/schemas/ResourceLimitExceededException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: maxResults in: query required: false description: The maximum number of invitations to return. schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: The pagination token that indicates the next set of results to retrieve. schema: type: string maxLength: 128 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Managed Blockchain List Invitations parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/networks/{networkId}/proposals/{proposalId}/votes': get: operationId: ListProposalVotes description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListProposalVotesOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '482': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '483': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: ' The unique identifier of the network. ' schema: type: string minLength: 1 maxLength: 32 - name: proposalId in: path required: true description: ' The unique identifier of the proposal. ' schema: type: string minLength: 1 maxLength: 32 - name: maxResults in: query required: false description: ' The maximum number of votes to return. ' schema: type: integer minimum: 1 maximum: 100 - name: nextToken in: query required: false description: ' The pagination token that indicates the next set of results to retrieve. ' schema: type: string maxLength: 128 - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false summary: Amazon Managed Blockchain List Proposal Votes parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: VoteOnProposal description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/VoteOnProposalOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: IllegalActionException content: application/json: schema: $ref: '#/components/schemas/IllegalActionException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: networkId in: path required: true description: ' The unique identifier of the network. ' schema: type: string minLength: 1 maxLength: 32 - name: proposalId in: path required: true description: ' The unique identifier of the proposal. ' schema: type: string minLength: 1 maxLength: 32 requestBody: required: true content: application/json: schema: type: object required: - VoterMemberId - Vote properties: VoterMemberId: description: 'The unique identifier of the member casting the vote. ' type: string minLength: 1 maxLength: 32 Vote: description: ' The value of the vote. ' type: string enum: - 'YES' - 'NO' summary: Amazon Managed Blockchain Vote on Proposal '/tags/{resourceArn}': get: operationId: ListTagsForResource description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' '480': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' parameters: - name: resourceArn in: path required: true description: '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.' schema: type: string pattern: '^arn:.+:.+:.+:.+:.+' minLength: 1 maxLength: 1011 summary: Amazon Managed Blockchain List Tags for Resource parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: TagResource description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TagResourceResponse' '480': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: TooManyTagsException content: application/json: schema: $ref: '#/components/schemas/TooManyTagsException' '484': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' parameters: - name: resourceArn in: path required: true description: '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.' schema: type: string pattern: '^arn:.+:.+:.+:.+:.+' minLength: 1 maxLength: 1011 requestBody: required: true content: application/json: schema: type: object required: - Tags properties: Tags: description: '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.'
type: object
minProperties: 0
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon Managed Blockchain Tag Resource
'/invitations/{invitationId}':
delete:
operationId: RejectInvitation
description: 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.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RejectInvitationOutput' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: IllegalActionException content: application/json: schema: $ref: '#/components/schemas/IllegalActionException' '482': description: AccessDeniedException content: application/json: schema: $ref: '#/components/schemas/AccessDeniedException' '483': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '484': description: ThrottlingException content: application/json: schema: $ref: '#/components/schemas/ThrottlingException' '485': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' parameters: - name: invitationId in: path required: true description: The unique identifier of the invitation to reject. schema: type: string minLength: 1 maxLength: 32 summary: Amazon Managed Blockchain Reject Invitation parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' '/tags/{resourceArn}#tagKeys': delete: operationId: UntagResource description: '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.
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/UntagResourceResponse' '480': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '481': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: ResourceNotReadyException content: application/json: schema: $ref: '#/components/schemas/ResourceNotReadyException' parameters: - name: resourceArn in: path required: true description: '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.' schema: type: string pattern: '^arn:.+:.+:.+:.+:.+' minLength: 1 maxLength: 1011 - name: tagKeys in: query required: true description: The tag keys. schema: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 200 summary: Amazon Managed Blockchain Untag Resource parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: CreateAccessorOutput: type: object properties: AccessorId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the accessor. BillingToken: allOf: - $ref: '#/components/schemas/AccessorBillingTokenString' - description: The billing token is a property of the Accessor. Use this token to make Ethereum API calls to your Ethereum node. The billing token is used to track your accessor object for billing Ethereum API requests made to your Ethereum nodes. TagValue: type: string minLength: 0 maxLength: 256 InvalidRequestException: {} AccessDeniedException: {} ResourceAlreadyExistsException: {} ThrottlingException: {} ResourceLimitExceededException: {} InternalServiceErrorException: {} TooManyTagsException: {} CreateMemberOutput: type: object properties: MemberId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the member. NetworkMemberNameString: type: string pattern: '^(?!-|[0-9])(?!.*-$)(?!.*?--)[a-zA-Z0-9-]+$' minLength: 1 maxLength: 64 DescriptionString: type: string maxLength: 128 MemberFrameworkConfiguration: type: object properties: Fabric: allOf: - $ref: '#/components/schemas/MemberFabricConfiguration' - description: Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric. description: Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses. MemberLogPublishingConfiguration: type: object properties: Fabric: allOf: - $ref: '#/components/schemas/MemberFabricLogPublishingConfiguration' - description: Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework. description: Configuration properties for logging events associated with a member of a Managed Blockchain network. InputTagMap: type: object minProperties: 0 maxProperties: 50 additionalProperties: $ref: '#/components/schemas/TagValue' ArnString: type: string pattern: '^arn:.+:.+:.+:.+:.+' minLength: 1 maxLength: 1011 ResourceNotFoundException: {} ResourceNotReadyException: {} CreateNetworkOutput: type: object properties: NetworkId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier for the network. MemberId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier for the first member within the network. NetworkFabricConfiguration: type: object required: - Edition properties: Edition: allOf: - $ref: '#/components/schemas/Edition' - description: 'The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.' description: Hyperledger Fabric configuration properties for the network. ApprovalThresholdPolicy: type: object properties: ThresholdPercentage: allOf: - $ref: '#/components/schemas/ThresholdPercentageInt' - description: 'The percentage of votes among all members that must beYES 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.'
ProposalDurationInHours:
allOf:
- $ref: '#/components/schemas/ProposalDurationInt'
- description: '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.'
ThresholdComparator:
allOf:
- $ref: '#/components/schemas/ThresholdComparator'
- description: Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be
approved.
description: 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.
CreateNodeOutput: type: object properties: NodeId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the node. InstanceTypeString: type: string AvailabilityZoneString: type: string NodeLogPublishingConfiguration: type: object properties: Fabric: allOf: - $ref: '#/components/schemas/NodeFabricLogPublishingConfiguration' - description: 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. description: Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain. StateDBType: type: string enum: - LevelDB - CouchDB CreateProposalOutput: type: object properties: ProposalId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the proposal. InviteActionList: type: array items: $ref: '#/components/schemas/InviteAction' RemoveActionList: type: array items: $ref: '#/components/schemas/RemoveAction' DeleteAccessorOutput: type: object properties: {} DeleteMemberOutput: type: object properties: {} DeleteNodeOutput: type: object properties: {} GetAccessorOutput: type: object properties: Accessor: allOf: - $ref: '#/components/schemas/Accessor' - description: The properties of the accessor. GetMemberOutput: type: object properties: Member: allOf: - $ref: '#/components/schemas/Member' - description: The properties of a member. GetNetworkOutput: type: object properties: Network: allOf: - $ref: '#/components/schemas/Network' - description: An object containing network configuration parameters. GetNodeOutput: type: object properties: Node: allOf: - $ref: '#/components/schemas/Node' - description: Properties of the node configuration. GetProposalOutput: type: object properties: Proposal: allOf: - $ref: '#/components/schemas/Proposal' - description: Information about a proposal. ListAccessorsOutput: type: object properties: Accessors: allOf: - $ref: '#/components/schemas/AccessorSummaryList' - description: An array of AccessorSummary objects that contain configuration properties for each accessor. NextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: ' The pagination token that indicates the next set of results to retrieve. ' ListInvitationsOutput: type: object properties: Invitations: allOf: - $ref: '#/components/schemas/InvitationList' - description: The invitations for the network. NextToken: allOf: - $ref: '#/components/schemas/PaginationToken' - description: The pagination token that indicates the next set of results to retrieve. ListMembersOutput: type: object properties: Members: allOf: - $ref: '#/components/schemas/MemberSummaryList' - description: An array ofMemberSummary objects. Each object contains details about a network member.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: The pagination token that indicates the next set of results to retrieve.
ListNetworksOutput:
type: object
properties:
Networks:
allOf:
- $ref: '#/components/schemas/NetworkSummaryList'
- description: An array of NetworkSummary objects that contain configuration properties for each network.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: The pagination token that indicates the next set of results to retrieve.
ListNodesOutput:
type: object
properties:
Nodes:
allOf:
- $ref: '#/components/schemas/NodeSummaryList'
- description: An array of NodeSummary objects that contain configuration properties for each node.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: The pagination token that indicates the next set of results to retrieve.
ListProposalVotesOutput:
type: object
properties:
ProposalVotes:
allOf:
- $ref: '#/components/schemas/ProposalVoteList'
- description: ' The list of votes. '
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: ' The pagination token that indicates the next set of results to retrieve. '
ListProposalsOutput:
type: object
properties:
Proposals:
allOf:
- $ref: '#/components/schemas/ProposalSummaryList'
- description: The summary of each proposal made on the network.
NextToken:
allOf:
- $ref: '#/components/schemas/PaginationToken'
- description: The pagination token that indicates the next set of results to retrieve.
ListTagsForResourceResponse:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/OutputTagMap'
- description: The tags assigned to the resource.
RejectInvitationOutput:
type: object
properties: {}
IllegalActionException: {}
TagResourceResponse:
type: object
properties: {}
UntagResourceResponse:
type: object
properties: {}
TagKey:
type: string
minLength: 1
maxLength: 128
UpdateMemberOutput:
type: object
properties: {}
MemberFabricLogPublishingConfiguration:
type: object
properties:
CaLogs:
allOf:
- $ref: '#/components/schemas/LogConfigurations'
- description: '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.'
description: Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.
UpdateNodeOutput:
type: object
properties: {}
NodeFabricLogPublishingConfiguration:
type: object
properties:
ChaincodeLogs:
allOf:
- $ref: '#/components/schemas/LogConfigurations'
- description: '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:
allOf:
- $ref: '#/components/schemas/LogConfigurations'
- description: '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. '
description: Configuration properties for logging events associated with a peer node owned by a member in a Managed Blockchain network.
VoteOnProposalOutput:
type: object
properties: {}
ResourceIdString:
type: string
minLength: 1
maxLength: 32
AccessorType:
type: string
enum:
- BILLING_TOKEN
AccessorBillingTokenString:
type: string
minLength: 42
maxLength: 42
AccessorStatus:
type: string
enum:
- AVAILABLE
- PENDING_DELETION
- DELETED
Timestamp:
type: string
format: date-time
OutputTagMap:
type: object
minProperties: 0
maxProperties: 200
additionalProperties:
$ref: '#/components/schemas/TagValue'
Accessor:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceIdString'
- description: The unique identifier of the accessor.
Type:
allOf:
- $ref: '#/components/schemas/AccessorType'
- description: 'The type of the accessor.
Currently, accessor type is restricted to BILLING_TOKEN.
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.
' description: The properties of the Accessor. AccessorListMaxResults: type: integer minimum: 1 maximum: 50 AccessorSummary: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the accessor. Type: allOf: - $ref: '#/components/schemas/AccessorType' - description:The type of the accessor.
Currently accessor type is restricted to BILLING_TOKEN.
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.
' MemberConfiguration: type: object required: - Name - FrameworkConfiguration properties: Name: allOf: - $ref: '#/components/schemas/NetworkMemberNameString' - description: The name of the member. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: An optional description of the member. FrameworkConfiguration: allOf: - $ref: '#/components/schemas/MemberFrameworkConfiguration' - description: Configuration properties of the blockchain framework relevant to the member. LogPublishingConfiguration: allOf: - $ref: '#/components/schemas/MemberLogPublishingConfiguration' - description: Configuration properties for logging events associated with a member of a Managed Blockchain network. Tags: allOf: - $ref: '#/components/schemas/InputTagMap' - description: '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: allOf: - $ref: '#/components/schemas/ArnString' - description: '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.
CreateMemberInput: type: object required: - ClientRequestToken - InvitationId - MemberConfiguration title: CreateMemberInput properties: ClientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestTokenString' - description: '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.' InvitationId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the invitation that is sent to the member to join the network. MemberConfiguration: allOf: - $ref: '#/components/schemas/MemberConfiguration' - description: Member configuration parameters. NameString: type: string pattern: .*\S.* minLength: 1 maxLength: 64 Framework: type: string enum: - HYPERLEDGER_FABRIC - ETHEREUM FrameworkVersionString: type: string minLength: 1 maxLength: 8 NetworkFrameworkConfiguration: type: object properties: Fabric: allOf: - $ref: '#/components/schemas/NetworkFabricConfiguration' - description: ' Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric. ' description: ' Configuration properties relevant to the network for the blockchain framework that the network uses. ' VotingPolicy: type: object properties: ApprovalThresholdPolicy: allOf: - $ref: '#/components/schemas/ApprovalThresholdPolicy' - description: 'Defines the rules for the network for voting on proposals, such as the percentage ofYES 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.'
description: The voting rules for the network to decide if a proposal is accepted
Applies only to Hyperledger Fabric.
CreateNetworkInput: type: object required: - ClientRequestToken - Name - Framework - FrameworkVersion - VotingPolicy - MemberConfiguration title: CreateNetworkInput properties: ClientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestTokenString' - description: '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. ' Name: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the network. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: An optional description for the network. Framework: allOf: - $ref: '#/components/schemas/Framework' - description: The blockchain framework that the network uses. FrameworkVersion: allOf: - $ref: '#/components/schemas/FrameworkVersionString' - description: The version of the blockchain framework that the network uses. FrameworkConfiguration: allOf: - $ref: '#/components/schemas/NetworkFrameworkConfiguration' - description: ' Configuration properties of the blockchain framework relevant to the network configuration. ' VotingPolicy: allOf: - $ref: '#/components/schemas/VotingPolicy' - description: ' The voting rules used by the network to determine if a proposal is approved. ' MemberConfiguration: allOf: - $ref: '#/components/schemas/MemberConfiguration' - description: Configuration properties for the first member within the network. Tags: allOf: - $ref: '#/components/schemas/InputTagMap' - description: '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.
' NodeConfiguration: type: object required: - InstanceType properties: InstanceType: allOf: - $ref: '#/components/schemas/InstanceTypeString' - description: The Amazon Managed Blockchain instance type for the node. AvailabilityZone: allOf: - $ref: '#/components/schemas/AvailabilityZoneString' - description: 'The Availability Zone in which the node exists. Required for Ethereum nodes. ' LogPublishingConfiguration: allOf: - $ref: '#/components/schemas/NodeLogPublishingConfiguration' - description: 'Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain. ' StateDB: allOf: - $ref: '#/components/schemas/StateDBType' - description: '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.
' description: Configuration properties of a node. CreateNodeInput: type: object required: - ClientRequestToken - NodeConfiguration title: CreateNodeInput properties: ClientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestTokenString' - description: '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.' MemberId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description:The unique identifier of the member that owns this node.
Applies only to Hyperledger Fabric.
NodeConfiguration: allOf: - $ref: '#/components/schemas/NodeConfiguration' - description: The properties of a node configuration. Tags: allOf: - $ref: '#/components/schemas/InputTagMap' - description: '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.
' ProposalActions: type: object properties: Invitations: allOf: - $ref: '#/components/schemas/InviteActionList' - description: ' The actions to perform for anAPPROVED proposal to invite an Amazon Web Services account to create a member and join the network. '
Removals:
allOf:
- $ref: '#/components/schemas/RemoveActionList'
- description: ' 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. '
description: The actions to carry out if a proposal is APPROVED.
Applies only to Hyperledger Fabric.
CreateProposalInput: type: object required: - ClientRequestToken - MemberId - Actions title: CreateProposalInput properties: ClientRequestToken: allOf: - $ref: '#/components/schemas/ClientRequestTokenString' - description: '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.' MemberId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: 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: allOf: - $ref: '#/components/schemas/ProposalActions' - description: 'The type of actions proposed, such as inviting a member or removing a member. The types ofActions in a proposal are mutually exclusive. For example, a proposal with
Invitations actions cannot also contain Removals actions.'
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: 'A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."'
Tags:
allOf:
- $ref: '#/components/schemas/InputTagMap'
- description: '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.
' DeleteAccessorInput: type: object title: DeleteAccessorInput properties: {} DeleteMemberInput: type: object title: DeleteMemberInput properties: {} DeleteNodeInput: type: object title: DeleteNodeInput properties: {} Edition: type: string enum: - STARTER - STANDARD Enabled: type: boolean GetAccessorInput: type: object title: GetAccessorInput properties: {} GetMemberInput: type: object title: GetMemberInput properties: {} Member: type: object properties: NetworkId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the network to which the member belongs. Id: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the member. Name: allOf: - $ref: '#/components/schemas/NetworkMemberNameString' - description: The name of the member. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: An optional description for the member. FrameworkAttributes: allOf: - $ref: '#/components/schemas/MemberFrameworkAttributes' - description: Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses. LogPublishingConfiguration: allOf: - $ref: '#/components/schemas/MemberLogPublishingConfiguration' - description: Configuration properties for logging events associated with a member. Status: allOf: - $ref: '#/components/schemas/MemberStatus' - description: '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.
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: allOf: - $ref: '#/components/schemas/ArnString' - description: '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: allOf: - $ref: '#/components/schemas/String' - description: '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.
' description:Member configuration properties.
Applies only to Hyperledger Fabric.
GetNetworkInput: type: object title: GetNetworkInput properties: {} Network: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the network. Name: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the network. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: Attributes of the blockchain framework for the network. Framework: allOf: - $ref: '#/components/schemas/Framework' - description: The blockchain framework that the network uses. FrameworkVersion: allOf: - $ref: '#/components/schemas/FrameworkVersionString' - description: The version of the blockchain framework that the network uses. FrameworkAttributes: allOf: - $ref: '#/components/schemas/NetworkFrameworkAttributes' - description: Attributes of the blockchain framework that the network uses. VpcEndpointServiceName: allOf: - $ref: '#/components/schemas/String' - description: 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: allOf: - $ref: '#/components/schemas/VotingPolicy' - description: The voting rules that the network uses to decide if a proposal is accepted. Status: allOf: - $ref: '#/components/schemas/NetworkStatus' - description: The current status of the network. CreationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time that the network was created. Tags: allOf: - $ref: '#/components/schemas/OutputTagMap' - description: '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: allOf: - $ref: '#/components/schemas/ArnString' - description: '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.' description: Network configuration properties. GetNodeInput: type: object title: GetNodeInput properties: {} Node: type: object properties: NetworkId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the network that the node is on. MemberId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description:The unique identifier of the member to which the node belongs.
Applies only to Hyperledger Fabric.
Id: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the node. InstanceType: allOf: - $ref: '#/components/schemas/InstanceTypeString' - description: The instance type of the node. AvailabilityZone: allOf: - $ref: '#/components/schemas/AvailabilityZoneString' - description: 'The Availability Zone in which the node exists. Required for Ethereum nodes. ' FrameworkAttributes: allOf: - $ref: '#/components/schemas/NodeFrameworkAttributes' - description: Attributes of the blockchain framework being used. LogPublishingConfiguration: allOf: - $ref: '#/components/schemas/NodeLogPublishingConfiguration' - description: Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain. StateDB: allOf: - $ref: '#/components/schemas/StateDBType' - description:The state database that the node uses. Values are LevelDB or CouchDB.
Applies only to Hyperledger Fabric.
Status: allOf: - $ref: '#/components/schemas/NodeStatus' - description: '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.
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: allOf: - $ref: '#/components/schemas/ArnString' - description: '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: allOf: - $ref: '#/components/schemas/String' - description: '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.
' description: Configuration properties of a node. GetProposalInput: type: object title: GetProposalInput properties: {} Proposal: type: object properties: ProposalId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the proposal. NetworkId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the network for which the proposal is made. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: The description of the proposal. Actions: allOf: - $ref: '#/components/schemas/ProposalActions' - description: The actions to perform on the network if the proposal isAPPROVED.
ProposedByMemberId:
allOf:
- $ref: '#/components/schemas/ResourceIdString'
- description: The unique identifier of the member that created the proposal.
ProposedByMemberName:
allOf:
- $ref: '#/components/schemas/NetworkMemberNameString'
- description: The name of the member that created the proposal.
Status:
allOf:
- $ref: '#/components/schemas/ProposalStatus'
- description: '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.
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. '
YesVoteCount:
allOf:
- $ref: '#/components/schemas/VoteCount'
- description: ' The current total of YES votes cast on the proposal by members. '
NoVoteCount:
allOf:
- $ref: '#/components/schemas/VoteCount'
- description: ' The current total of NO votes cast on the proposal by members. '
OutstandingVoteCount:
allOf:
- $ref: '#/components/schemas/VoteCount'
- description: ' 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:
allOf:
- $ref: '#/components/schemas/OutputTagMap'
- description: '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: allOf: - $ref: '#/components/schemas/ArnString' - description: '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.' description:Properties of a proposal on a Managed Blockchain network.
Applies only to Hyperledger Fabric.
InvitationStatus: type: string enum: - PENDING - ACCEPTED - ACCEPTING - REJECTED - EXPIRED NetworkSummary: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the network. Name: allOf: - $ref: '#/components/schemas/NameString' - description: The name of the network. Description: allOf: - $ref: '#/components/schemas/DescriptionString' - description: An optional description of the network. Framework: allOf: - $ref: '#/components/schemas/Framework' - description: The blockchain framework that the network uses. FrameworkVersion: allOf: - $ref: '#/components/schemas/FrameworkVersionString' - description: The version of the blockchain framework that the network uses. Status: allOf: - $ref: '#/components/schemas/NetworkStatus' - description: The current status of the network. CreationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time that the network was created. Arn: allOf: - $ref: '#/components/schemas/ArnString' - description: '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.' description: A summary of network configuration properties. Invitation: type: object properties: InvitationId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier for the invitation. CreationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: The date and time that the invitation was created. ExpirationDate: allOf: - $ref: '#/components/schemas/Timestamp' - description: 'The date and time that the invitation expires. This is theCreationDate 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.'
Status:
allOf:
- $ref: '#/components/schemas/InvitationStatus'
- description: '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.
An invitation to an Amazon Web Services account to create a member and join the network.
Applies only to Hyperledger Fabric.
InvitationList: type: array items: $ref: '#/components/schemas/Invitation' PrincipalString: type: string InviteAction: type: object required: - Principal properties: Principal: allOf: - $ref: '#/components/schemas/PrincipalString' - description: The Amazon Web Services account ID to invite. description: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.
IsOwned: type: boolean PaginationToken: type: string maxLength: 128 ListAccessorsInput: type: object title: ListAccessorsInput properties: {} ProposalListMaxResults: type: integer minimum: 1 maximum: 100 ListInvitationsInput: type: object title: ListInvitationsInput properties: {} String: type: string MemberStatus: type: string enum: - CREATING - AVAILABLE - CREATE_FAILED - UPDATING - DELETING - DELETED - INACCESSIBLE_ENCRYPTION_KEY MemberListMaxResults: type: integer minimum: 1 maximum: 20 ListMembersInput: type: object title: ListMembersInput properties: {} MemberSummaryList: type: array items: $ref: '#/components/schemas/MemberSummary' NetworkStatus: type: string enum: - CREATING - AVAILABLE - CREATE_FAILED - DELETING - DELETED NetworkListMaxResults: type: integer minimum: 1 maximum: 10 ListNetworksInput: type: object title: ListNetworksInput properties: {} NetworkSummaryList: type: array items: $ref: '#/components/schemas/NetworkSummary' NodeStatus: type: string enum: - CREATING - AVAILABLE - UNHEALTHY - CREATE_FAILED - UPDATING - DELETING - DELETED - FAILED - INACCESSIBLE_ENCRYPTION_KEY NodeListMaxResults: type: integer minimum: 1 maximum: 20 ListNodesInput: type: object title: ListNodesInput properties: {} NodeSummaryList: type: array items: $ref: '#/components/schemas/NodeSummary' ListProposalVotesInput: type: object title: ListProposalVotesInput properties: {} ProposalVoteList: type: array items: $ref: '#/components/schemas/VoteSummary' ListProposalsInput: type: object title: ListProposalsInput properties: {} ProposalSummaryList: type: array items: $ref: '#/components/schemas/ProposalSummary' ListTagsForResourceRequest: type: object title: ListTagsForResourceRequest properties: {} LogConfiguration: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Enabled' - description: Indicates whether logging is enabled. description: A configuration for logging events. LogConfigurations: type: object properties: Cloudwatch: allOf: - $ref: '#/components/schemas/LogConfiguration' - description: Parameters for publishing logs to Amazon CloudWatch Logs. description: A collection of log configurations. MemberFrameworkAttributes: type: object properties: Fabric: allOf: - $ref: '#/components/schemas/MemberFabricAttributes' - description: Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger Fabric. description: Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses. UsernameString: type: string pattern: '^[a-zA-Z][a-zA-Z0-9]*$' minLength: 1 maxLength: 16 MemberFabricAttributes: type: object properties: AdminUsername: allOf: - $ref: '#/components/schemas/UsernameString' - description: The user name for the initial administrator user for the member. CaEndpoint: allOf: - $ref: '#/components/schemas/String' - description: The endpoint used to access the member's certificate authority. description: Attributes of Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework. PasswordString: type: string pattern: '^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?!.*[@''\\"/])[a-zA-Z0-9\S]*$' minLength: 8 maxLength: 32 format: password MemberFabricConfiguration: type: object required: - AdminUsername - AdminPassword properties: AdminUsername: allOf: - $ref: '#/components/schemas/UsernameString' - description: The user name for the member's initial administrative user. AdminPassword: allOf: - $ref: '#/components/schemas/PasswordString' - description: 'The password for the member''s initial administrative user. TheAdminPassword 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.'
description: Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network that is using the Hyperledger Fabric framework.
MemberSummary:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceIdString'
- description: The unique identifier of the member.
Name:
allOf:
- $ref: '#/components/schemas/NetworkMemberNameString'
- description: The name of the member.
Description:
allOf:
- $ref: '#/components/schemas/DescriptionString'
- description: An optional description of the member.
Status:
allOf:
- $ref: '#/components/schemas/MemberStatus'
- description: '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.
A summary of configuration properties for a member.
Applies only to Hyperledger Fabric.
NetworkFrameworkAttributes: type: object properties: Fabric: allOf: - $ref: '#/components/schemas/NetworkFabricAttributes' - description: Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric. Ethereum: allOf: - $ref: '#/components/schemas/NetworkEthereumAttributes' - description: 'Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network. ' description: Attributes relevant to the network for the blockchain framework that the network uses. NetworkEthereumAttributes: type: object properties: ChainId: allOf: - $ref: '#/components/schemas/String' - description: 'The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:
mainnet = 1
goerli = 5
rinkeby = 4
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.
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. '
Arn:
allOf:
- $ref: '#/components/schemas/ArnString'
- description: '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.'
description: Properties of a proposal.
Applies only to Hyperledger Fabric.
VoteSummary: type: object properties: Vote: allOf: - $ref: '#/components/schemas/VoteValue' - description: ' The vote value, eitherYES or NO. '
MemberName:
allOf:
- $ref: '#/components/schemas/NetworkMemberNameString'
- description: ' The name of the member that cast the vote. '
MemberId:
allOf:
- $ref: '#/components/schemas/ResourceIdString'
- description: ' The unique identifier of the member that cast the vote. '
description: Properties of an individual vote that a member cast for a proposal.
Applies only to Hyperledger Fabric.
RejectInvitationInput: type: object title: RejectInvitationInput properties: {} RemoveAction: type: object required: - MemberId properties: MemberId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: The unique identifier of the member to remove. description: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.
TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' minItems: 0 maxItems: 200 TagResourceRequest: type: object required: - Tags title: TagResourceRequest properties: Tags: allOf: - $ref: '#/components/schemas/InputTagMap' - description: '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.'
UntagResourceRequest:
type: object
title: UntagResourceRequest
properties: {}
UpdateMemberInput:
type: object
title: UpdateMemberInput
properties:
LogPublishingConfiguration:
allOf:
- $ref: '#/components/schemas/MemberLogPublishingConfiguration'
- description: Configuration properties for publishing to Amazon CloudWatch Logs.
UpdateNodeInput:
type: object
title: UpdateNodeInput
properties:
MemberId:
allOf:
- $ref: '#/components/schemas/ResourceIdString'
- description: The unique identifier of the member that owns the node.
Applies only to Hyperledger Fabric.
LogPublishingConfiguration: allOf: - $ref: '#/components/schemas/NodeLogPublishingConfiguration' - description: Configuration properties for publishing to Amazon CloudWatch Logs. VoteValue: type: string enum: - 'YES' - 'NO' VoteOnProposalInput: type: object required: - VoterMemberId - Vote title: VoteOnProposalInput properties: VoterMemberId: allOf: - $ref: '#/components/schemas/ResourceIdString' - description: 'The unique identifier of the member casting the vote. ' Vote: allOf: - $ref: '#/components/schemas/VoteValue' - description: ' The value of the vote. ' security: - hmac: []