The Networks API from Amazon Managed Blockchain — 9 operation(s) for networks.
openapi: 3.0.0
info:
version: '2018-09-24'
x-release: v4
title: Amazon Managed Blockchain Accessors Networks API
description: <p/> <p>Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.</p> <p>Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as <code>CreateMember</code> and <code>DeleteMember</code> don't apply to Ethereum.</p> <p>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.</p>
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
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)
security:
- hmac: []
tags:
- name: Networks
paths:
/networks/{networkId}/members:
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: CreateMember
description: <p>Creates a member within a Managed Blockchain network.</p> <p>Applies only to Hyperledger Fabric.</p>
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: <p>Configuration properties of the member.</p> <p>Applies only to Hyperledger Fabric.</p>
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: <p>Tags assigned to the member. Tags consist of a key and optional value. </p> <p>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.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href="https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>
KmsKeyArn:
allOf:
- $ref: '#/components/schemas/ArnString'
- description: '<p>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 <a href="https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html">Encryption at Rest</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p> <p>Use one of the following options to specify this parameter:</p> <ul> <li> <p> <b>Undefined or empty string</b> - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf.</p> </li> <li> <p> <b>A valid symmetric customer managed KMS key</b> - Use the specified KMS key in your account that you create, own, and manage.</p> <p>Amazon Managed Blockchain doesn''t support asymmetric keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The following is an example of a KMS key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul>'
summary: Amazon Managed Blockchain Create Member
tags:
- Networks
get:
operationId: ListMembers
description: <p>Returns a list of the members in a network and properties of their configurations.</p> <p>Applies only to Hyperledger Fabric.</p>
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 (<code>true</code>) or that other Amazon Web Services accountsn own (<code>false</code>). 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
tags:
- Networks
/networks:
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: CreateNetwork
description: <p>Creates a new blockchain network using Amazon Managed Blockchain.</p> <p>Applies only to Hyperledger Fabric.</p>
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: <p> The voting rules for the network to decide if a proposal is accepted </p> <p>Applies only to Hyperledger Fabric.</p>
type: object
properties:
ApprovalThresholdPolicy:
allOf:
- $ref: '#/components/schemas/ApprovalThresholdPolicy'
- description: Defines the rules for the network for voting on proposals, such as the percentage of <code>YES</code> 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: <p>Configuration properties of the member.</p> <p>Applies only to Hyperledger Fabric.</p>
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: <p>Tags assigned to the member. Tags consist of a key and optional value. </p> <p>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.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href="https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>
KmsKeyArn:
allOf:
- $ref: '#/components/schemas/ArnString'
- description: '<p>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 <a href="https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/managed-blockchain-encryption-at-rest.html">Encryption at Rest</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p> <p>Use one of the following options to specify this parameter:</p> <ul> <li> <p> <b>Undefined or empty string</b> - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf.</p> </li> <li> <p> <b>A valid symmetric customer managed KMS key</b> - Use the specified KMS key in your account that you create, own, and manage.</p> <p>Amazon Managed Blockchain doesn''t support asymmetric keys. For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html">Using symmetric and asymmetric keys</a> in the <i>Key Management Service Developer Guide</i>.</p> <p>The following is an example of a KMS key ARN: <code>arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code> </p> </li> </ul>'
Tags:
description: <p>Tags to assign to the network.</p> <p> 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.</p> <p>For more information about tags, see <a href="https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href="https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>
type: object
minProperties: 0
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon Managed Blockchain Create Network
tags:
- Networks
get:
operationId: ListNetworks
description: <p>Returns information about the networks in which the current Amazon Web Services account participates.</p> <p>Applies to Hyperledger Fabric and Ethereum.</p>
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: <p>An optional status specifier. If provided, only networks currently in this status are listed.</p> <p>Applies only to Hyperledger Fabric.</p>
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
tags:
- Networks
/networks/{networkId}/nodes:
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: CreateNode
description: <p>Creates a node on the specified blockchain network.</p> <p>Applies to Hyperledger Fabric and Ethereum.</p>
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: <p>The unique identifier of the network for the node.</p> <p>Ethereum public networks have the following <code>NetworkId</code>s:</p> <ul> <li> <p> <code>n-ethereum-mainnet</code> </p> </li> <li> <p> <code>n-ethereum-goerli</code> </p> </li> <li> <p> <code>n-ethereum-rinkeby</code> </p> </li> </ul>
schema:
type: string
minLength: 1
maxLength: 32
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ClientRequestToken
- NodeConfiguration
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: <p>The unique identifier of the member that owns this node.</p> <p>Applies only to Hyperledger Fabric.</p>
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: <p>The state database that the node uses. Values are <code>LevelDB</code> or <code>CouchDB</code>. When using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or later, the default is <code>CouchDB</code>.</p> <p>Applies only to Hyperledger Fabric.</p>
Tags:
description: <p>Tags
# --- truncated at 32 KB (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-managed-blockchain/refs/heads/main/openapi/amazon-managed-blockchain-networks-api-openapi.yml