openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 147 kB

JSON

{"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 <code>CreateMember</code> and <code>DeleteMember</code> 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. <note> Currently, accessor type is restricted to <code>BILLING_TOKEN</code>. </note>","type":"string","enum":["BILLING_TOKEN"]},"Tags":{"description":"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 <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Ethereum Developer Guide, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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}]}},"/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 <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Ethereum Developer Guide, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> 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 <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 Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Use one of the following options to specify this parameter: <ul> <li> Undefined or empty string - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf. </li> <li> 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 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the Key Management Service Developer Guide. 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> </li> </ul>"}]}}}}}}}}},"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":"ListMembers","description":"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 (<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}]}},"/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 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":"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 <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Ethereum Developer Guide, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> 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 <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 Amazon Managed Blockchain Hyperledger Fabric Developer Guide. Use one of the following options to specify this parameter: <ul> <li> Undefined or empty string - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf. </li> <li> 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 <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/symmetric-asymmetric.html\">Using symmetric and asymmetric keys</a> in the Key Management Service Developer Guide. 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> </li> </ul>"}]}}},"Tags":{"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 <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Ethereum Developer Guide, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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}]}},"/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 <code>NetworkId</code>s: <ul> <li> <code>n-ethereum-mainnet</code> </li> <li> <code>n-ethereum-goerli</code> </li> <li> <code>n-ethereum-rinkeby</code> </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":"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 <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>. 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 <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Ethereum Developer Guide, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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}]}},"/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 <code>APPROVED</code>. Applies only to Hyperledger Fabric.","type":"object","properties":{"Invitations":{"allOf":[{"$ref":"#/components/schemas/InviteActionList"},{"description":" The actions to perform for an <code>APPROVED</code> 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 <code>APPROVED</code> 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 <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Ethereum Developer Guide, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.","type":"object","minProperties":0,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"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}]}},"/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, the <code>BILLING_TOKEN</code>. After an accessor is deleted, the status of the accessor changes from <code>AVAILABLE</code> to <code>PENDING_DELETION</code>. An accessor in the <code>PENDING_DELETION</code> state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the <code>AVAILABLE</code> 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}}]},"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}}]}},"/networks/{networkId}/members/{memberId}":{"delete":{"operationId":"DeleteMember","description":"Deletes a member. Deleting a member removes the member and all associated resources from the network. <code>DeleteMember</code> can only be called for a specified <code>MemberId</code> if the principal performing the action is associated with the Amazon Web Services account that owns the member. In all other cases, the <code>DeleteMember</code> action is carried out as the result of an approved proposal to remove a member. If <code>MemberId</code> is the last member in a network specified by the last Amazon Web Services account, the network is deleted also. 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}}]},"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}}]},"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."}]}}}}}}}}}},"/networks/{networkId}/nodes/{nodeId}":{"delete":{"operationId":"DeleteNode","description":"Deletes a node that your Amazon Web Services account owns. All data on the