Class: AWS.ManagedBlockchain

Inherits:
AWS.Service show all
Identifier:
managedblockchain
API Version:
2018-09-24
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service 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. Currently, Managed Blockchain supports the Hyperledger Fabric open source framework.

Sending a Request Using ManagedBlockchain

var managedblockchain = new AWS.ManagedBlockchain();
managedblockchain.createMember(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ManagedBlockchain object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var managedblockchain = new AWS.ManagedBlockchain({apiVersion: '2018-09-24'});

You can also set the API version globally in AWS.config.apiVersions using the managedblockchain service identifier:

AWS.config.apiVersions = {
  managedblockchain: '2018-09-24',
  // other service API versions
};

var managedblockchain = new AWS.ManagedBlockchain();

Version:

  • 2018-09-24

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ManagedBlockchain(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ManagedBlockchain object

var managedblockchain = new AWS.ManagedBlockchain({apiVersion: '2018-09-24'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.ManagedBlockchain.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.ManagedBlockchain.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.ManagedBlockchain.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean)

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

createMember(params = {}, callback) ⇒ AWS.Request

Creates a member within a Managed Blockchain network.

Service Reference:

Examples:

Calling the createMember operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  InvitationId: 'STRING_VALUE', /* required */
  MemberConfiguration: { /* required */
    FrameworkConfiguration: { /* required */
      Fabric: {
        AdminPassword: 'STRING_VALUE', /* required */
        AdminUsername: 'STRING_VALUE' /* required */
      }
    },
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE'
  },
  NetworkId: 'STRING_VALUE' /* required */
};
managedblockchain.createMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      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 AWS SDK or the AWS CLI.

      If a token is not provided, the SDK will use a version 4 UUID.
    • InvitationId — (String)

      The unique identifier of the invitation that is sent to the member to join the network.

    • NetworkId — (String)

      The unique identifier of the network in which the member is created.

    • MemberConfiguration — (map)

      Member configuration parameters.

      • Namerequired — (String)

        The name of the member.

      • Description — (String)

        An optional description of the member.

      • FrameworkConfigurationrequired — (map)

        Configuration properties of the blockchain framework relevant to the member.

        • Fabric — (map)

          Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.

          • AdminUsernamerequired — (String)

            The user name for the member's initial administrative user.

          • AdminPasswordrequired — (String)

            The password for the member's initial administrative user. The AdminPassword must be at least eight 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 quote(‘), double quote(“), forward slash(/), backward slash(), @, or a space.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • MemberId — (String)

        The unique identifier of the member.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createNetwork(params = {}, callback) ⇒ AWS.Request

Creates a new blockchain network using Amazon Managed Blockchain.

Service Reference:

Examples:

Calling the createNetwork operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  Framework: HYPERLEDGER_FABRIC, /* required */
  FrameworkVersion: 'STRING_VALUE', /* required */
  MemberConfiguration: { /* required */
    FrameworkConfiguration: { /* required */
      Fabric: {
        AdminPassword: 'STRING_VALUE', /* required */
        AdminUsername: 'STRING_VALUE' /* required */
      }
    },
    Name: 'STRING_VALUE', /* required */
    Description: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE', /* required */
  VotingPolicy: { /* required */
    ApprovalThresholdPolicy: {
      ProposalDurationInHours: 'NUMBER_VALUE',
      ThresholdComparator: GREATER_THAN | GREATER_THAN_OR_EQUAL_TO,
      ThresholdPercentage: 'NUMBER_VALUE'
    }
  },
  Description: 'STRING_VALUE',
  FrameworkConfiguration: {
    Fabric: {
      Edition: STARTER | STANDARD /* required */
    }
  }
};
managedblockchain.createNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      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 AWS SDK or the AWS CLI.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Name — (String)

      The name of the network.

    • Description — (String)

      An optional description for the network.

    • Framework — (String)

      The blockchain framework that the network uses.

      Possible values include:
      • "HYPERLEDGER_FABRIC"
    • FrameworkVersion — (String)

      The version of the blockchain framework that the network uses.

    • FrameworkConfiguration — (map)

      Configuration properties of the blockchain framework relevant to the network configuration.

      • Fabric — (map)

        Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric.

        • Editionrequired — (String)

          The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.

          Possible values include:
          • "STARTER"
          • "STANDARD"
    • VotingPolicy — (map)

      The voting rules used by the network to determine if a proposal is approved.

      • ApprovalThresholdPolicy — (map)

        Defines the rules for the network for voting on proposals, such as the percentage of YES votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

        • ThresholdPercentage — (Integer)

          The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be approved.

        • ProposalDurationInHours — (Integer)

          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 are not carried out.

        • ThresholdComparator — (String)

          Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.

          Possible values include:
          • "GREATER_THAN"
          • "GREATER_THAN_OR_EQUAL_TO"
    • MemberConfiguration — (map)

      Configuration properties for the first member within the network.

      • Namerequired — (String)

        The name of the member.

      • Description — (String)

        An optional description of the member.

      • FrameworkConfigurationrequired — (map)

        Configuration properties of the blockchain framework relevant to the member.

        • Fabric — (map)

          Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.

          • AdminUsernamerequired — (String)

            The user name for the member's initial administrative user.

          • AdminPasswordrequired — (String)

            The password for the member's initial administrative user. The AdminPassword must be at least eight 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 quote(‘), double quote(“), forward slash(/), backward slash(), @, or a space.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NetworkId — (String)

        The unique identifier for the network.

      • MemberId — (String)

        The unique identifier for the first member within the network.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createNode(params = {}, callback) ⇒ AWS.Request

Creates a peer node in a member.

Service Reference:

Examples:

Calling the createNode operation

var params = {
  ClientRequestToken: 'STRING_VALUE', /* required */
  MemberId: 'STRING_VALUE', /* required */
  NetworkId: 'STRING_VALUE', /* required */
  NodeConfiguration: { /* required */
    AvailabilityZone: 'STRING_VALUE', /* required */
    InstanceType: 'STRING_VALUE' /* required */
  }
};
managedblockchain.createNode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      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 AWS SDK or the AWS CLI.

      If a token is not provided, the SDK will use a version 4 UUID.
    • NetworkId — (String)

      The unique identifier of the network in which this node runs.

    • MemberId — (String)

      The unique identifier of the member that owns this node.

    • NodeConfiguration — (map)

      The properties of a node configuration.

      • InstanceTyperequired — (String)

        The Amazon Managed Blockchain instance type for the node.

      • AvailabilityZonerequired — (String)

        The Availability Zone in which the node exists.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NodeId — (String)

        The unique identifier of the node.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createProposal(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createProposal operation

var params = {
  Actions: { /* required */
    Invitations: [
      {
        Principal: 'STRING_VALUE' /* required */
      },
      /* more items */
    ],
    Removals: [
      {
        MemberId: 'STRING_VALUE' /* required */
      },
      /* more items */
    ]
  },
  ClientRequestToken: 'STRING_VALUE', /* required */
  MemberId: 'STRING_VALUE', /* required */
  NetworkId: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE'
};
managedblockchain.createProposal(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ClientRequestToken — (String)

      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 AWS SDK or the AWS CLI.

      If a token is not provided, the SDK will use a version 4 UUID.
    • NetworkId — (String)

      The unique identifier of the network for which the proposal is made.

    • MemberId — (String)

      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 AWS account.

    • Actions — (map)

      The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions.

      • Invitations — (Array<map>)

        The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join the network.

        • Principalrequired — (String)

          The AWS account ID to invite.

      • Removals — (Array<map>)

        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.

        • MemberIdrequired — (String)

          The unique identifier of the member to remove.

    • Description — (String)

      A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProposalId — (String)

        The unique identifier of the proposal.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteMember(params = {}, callback) ⇒ AWS.Request

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 AWS 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 AWS account, the network is deleted also.

Service Reference:

Examples:

Calling the deleteMember operation

var params = {
  MemberId: 'STRING_VALUE', /* required */
  NetworkId: 'STRING_VALUE' /* required */
};
managedblockchain.deleteMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network from which the member is removed.

    • MemberId — (String)

      The unique identifier of the member to remove.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteNode(params = {}, callback) ⇒ AWS.Request

Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered.

Service Reference:

Examples:

Calling the deleteNode operation

var params = {
  MemberId: 'STRING_VALUE', /* required */
  NetworkId: 'STRING_VALUE', /* required */
  NodeId: 'STRING_VALUE' /* required */
};
managedblockchain.deleteNode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network that the node belongs to.

    • MemberId — (String)

      The unique identifier of the member that owns this node.

    • NodeId — (String)

      The unique identifier of the node.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getMember(params = {}, callback) ⇒ AWS.Request

Returns detailed information about a member.

Service Reference:

Examples:

Calling the getMember operation

var params = {
  MemberId: 'STRING_VALUE', /* required */
  NetworkId: 'STRING_VALUE' /* required */
};
managedblockchain.getMember(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network to which the member belongs.

    • MemberId — (String)

      The unique identifier of the member.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Member — (map)

        The properties of a member.

        • NetworkId — (String)

          The unique identifier of the network to which the member belongs.

        • Id — (String)

          The unique identifier of the member.

        • Name — (String)

          The name of the member.

        • Description — (String)

          An optional description for the member.

        • FrameworkAttributes — (map)

          Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

          • Fabric — (map)

            Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger Fabric.

            • AdminUsername — (String)

              The user name for the initial administrator user for the member.

            • CaEndpoint — (String)

              The endpoint used to access the member's certificate authority.

        • Status — (String)

          The status of a member.

          • CREATING - The AWS account is in the process of creating a member.

          • AVAILABLE - The member has been created and can participate in the network.

          • CREATE_FAILED - The AWS account attempted to create a member and creation failed.

          • DELETING - The member and all associated resources are in the process of being deleted. Either the AWS 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 AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "CREATE_FAILED"
          • "DELETING"
          • "DELETED"
        • CreationDate — (Date)

          The date and time that the member was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getNetwork(params = {}, callback) ⇒ AWS.Request

Returns detailed information about a network.

Service Reference:

Examples:

Calling the getNetwork operation

var params = {
  NetworkId: 'STRING_VALUE' /* required */
};
managedblockchain.getNetwork(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network to get information about.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Network — (map)

        An object containing network configuration parameters.

        • Id — (String)

          The unique identifier of the network.

        • Name — (String)

          The name of the network.

        • Description — (String)

          Attributes of the blockchain framework for the network.

        • Framework — (String)

          The blockchain framework that the network uses.

          Possible values include:
          • "HYPERLEDGER_FABRIC"
        • FrameworkVersion — (String)

          The version of the blockchain framework that the network uses.

        • FrameworkAttributes — (map)

          Attributes of the blockchain framework that the network uses.

          • Fabric — (map)

            Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric.

            • OrderingServiceEndpoint — (String)

              The endpoint of the ordering service for the network.

            • Edition — (String)

              The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing.

              Possible values include:
              • "STARTER"
              • "STANDARD"
        • VpcEndpointServiceName — (String)

          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 — (map)

          The voting rules for the network to decide if a proposal is accepted.

          • ApprovalThresholdPolicy — (map)

            Defines the rules for the network for voting on proposals, such as the percentage of YES votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

            • ThresholdPercentage — (Integer)

              The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be approved.

            • ProposalDurationInHours — (Integer)

              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 are not carried out.

            • ThresholdComparator — (String)

              Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.

              Possible values include:
              • "GREATER_THAN"
              • "GREATER_THAN_OR_EQUAL_TO"
        • Status — (String)

          The current status of the network.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "CREATE_FAILED"
          • "DELETING"
          • "DELETED"
        • CreationDate — (Date)

          The date and time that the network was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getNode(params = {}, callback) ⇒ AWS.Request

Returns detailed information about a peer node.

Service Reference:

Examples:

Calling the getNode operation

var params = {
  MemberId: 'STRING_VALUE', /* required */
  NetworkId: 'STRING_VALUE', /* required */
  NodeId: 'STRING_VALUE' /* required */
};
managedblockchain.getNode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network to which the node belongs.

    • MemberId — (String)

      The unique identifier of the member that owns the node.

    • NodeId — (String)

      The unique identifier of the node.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Node — (map)

        Properties of the node configuration.

        • NetworkId — (String)

          The unique identifier of the network that the node is in.

        • MemberId — (String)

          The unique identifier of the member to which the node belongs.

        • Id — (String)

          The unique identifier of the node.

        • InstanceType — (String)

          The instance type of the node.

        • AvailabilityZone — (String)

          The Availability Zone in which the node exists.

        • FrameworkAttributes — (map)

          Attributes of the blockchain framework being used.

          • Fabric — (map)

            Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.

            • PeerEndpoint — (String)

              The endpoint that identifies the peer node for all services except peer channel-based event services.

            • PeerEventEndpoint — (String)

              The endpoint that identifies the peer node for peer channel-based event services.

        • Status — (String)

          The status of the node.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "CREATE_FAILED"
          • "DELETING"
          • "DELETED"
          • "FAILED"
        • CreationDate — (Date)

          The date and time that the node was created.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getProposal(params = {}, callback) ⇒ AWS.Request

Returns detailed information about a proposal.

Service Reference:

Examples:

Calling the getProposal operation

var params = {
  NetworkId: 'STRING_VALUE', /* required */
  ProposalId: 'STRING_VALUE' /* required */
};
managedblockchain.getProposal(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network for which the proposal is made.

    • ProposalId — (String)

      The unique identifier of the proposal.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Proposal — (map)

        Information about a proposal.

        • ProposalId — (String)

          The unique identifier of the proposal.

        • NetworkId — (String)

          The unique identifier of the network for which the proposal is made.

        • Description — (String)

          The description of the proposal.

        • Actions — (map)

          The actions to perform on the network if the proposal is APPROVED.

          • Invitations — (Array<map>)

            The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join the network.

            • Principalrequired — (String)

              The AWS account ID to invite.

          • Removals — (Array<map>)

            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.

            • MemberIdrequired — (String)

              The unique identifier of the member to remove.

        • ProposedByMemberId — (String)

          The unique identifier of the member that created the proposal.

        • ProposedByMemberName — (String)

          The name of the member that created the proposal.

        • Status — (String)

          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 are not carried out.

          • EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.

          • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.

          Possible values include:
          • "IN_PROGRESS"
          • "APPROVED"
          • "REJECTED"
          • "EXPIRED"
          • "ACTION_FAILED"
        • CreationDate — (Date)

          The date and time that the proposal was created.

        • ExpirationDate — (Date)

          The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.

        • YesVoteCount — (Integer)

          The current total of YES votes cast on the proposal by members.

        • NoVoteCount — (Integer)

          The current total of NO votes cast on the proposal by members.

        • OutstandingVoteCount — (Integer)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listInvitations(params = {}, callback) ⇒ AWS.Request

Returns a listing of all invitations made on the specified network.

Service Reference:

Examples:

Calling the listInvitations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
managedblockchain.listInvitations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • MaxResults — (Integer)

      The maximum number of invitations to return.

    • NextToken — (String)

      The pagination token that indicates the next set of results to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Invitations — (Array<map>)

        The invitations for the network.

        • InvitationId — (String)

          The unique identifier for the invitation.

        • CreationDate — (Date)

          The date and time that the invitation was created.

        • ExpirationDate — (Date)

          The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId.

        • Status — (String)

          The status of the invitation:

          • PENDING - The invitee has not created a member to join the network, and the invitation has not yet expired.

          • ACCEPTING - The invitee has begun creating a member, and creation has not 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.

          Possible values include:
          • "PENDING"
          • "ACCEPTED"
          • "ACCEPTING"
          • "REJECTED"
          • "EXPIRED"
        • NetworkSummary — (map)

          A summary of network configuration properties.

          • Id — (String)

            The unique identifier of the network.

          • Name — (String)

            The name of the network.

          • Description — (String)

            An optional description of the network.

          • Framework — (String)

            The blockchain framework that the network uses.

            Possible values include:
            • "HYPERLEDGER_FABRIC"
          • FrameworkVersion — (String)

            The version of the blockchain framework that the network uses.

          • Status — (String)

            The current status of the network.

            Possible values include:
            • "CREATING"
            • "AVAILABLE"
            • "CREATE_FAILED"
            • "DELETING"
            • "DELETED"
          • CreationDate — (Date)

            The date and time that the network was created.

      • NextToken — (String)

        The pagination token that indicates the next set of results to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listMembers(params = {}, callback) ⇒ AWS.Request

Returns a listing of the members in a network and properties of their configurations.

Service Reference:

Examples:

Calling the listMembers operation

var params = {
  NetworkId: 'STRING_VALUE', /* required */
  IsOwned: true || false,
  MaxResults: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Status: CREATING | AVAILABLE | CREATE_FAILED | DELETING | DELETED
};
managedblockchain.listMembers(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network for which to list members.

    • Name — (String)

      The optional name of the member to list.

    • Status — (String)

      An optional status specifier. If provided, only members currently in this status are listed.

      Possible values include:
      • "CREATING"
      • "AVAILABLE"
      • "CREATE_FAILED"
      • "DELETING"
      • "DELETED"
    • IsOwned — (Boolean)

      An optional Boolean value. If provided, the request is limited either to members that the current AWS account owns (true) or that other AWS accounts own (false). If omitted, all members are listed.

    • MaxResults — (Integer)

      The maximum number of members to return in the request.

    • NextToken — (String)

      The pagination token that indicates the next set of results to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Members — (Array<map>)

        An array of MemberSummary objects. Each object contains details about a network member.

        • Id — (String)

          The unique identifier of the member.

        • Name — (String)

          The name of the member.

        • Description — (String)

          An optional description of the member.

        • Status — (String)

          The status of the member.

          • CREATING - The AWS account is in the process of creating a member.

          • AVAILABLE - The member has been created and can participate in the network.

          • CREATE_FAILED - The AWS account attempted to create a member and creation failed.

          • DELETING - The member and all associated resources are in the process of being deleted. Either the AWS 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 AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "CREATE_FAILED"
          • "DELETING"
          • "DELETED"
        • CreationDate — (Date)

          The date and time that the member was created.

        • IsOwned — (Boolean)

          An indicator of whether the member is owned by your AWS account or a different AWS account.

      • NextToken — (String)

        The pagination token that indicates the next set of results to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listNetworks(params = {}, callback) ⇒ AWS.Request

Returns information about the networks in which the current AWS account has members.

Service Reference:

Examples:

Calling the listNetworks operation

var params = {
  Framework: HYPERLEDGER_FABRIC,
  MaxResults: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Status: CREATING | AVAILABLE | CREATE_FAILED | DELETING | DELETED
};
managedblockchain.listNetworks(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the network.

    • Framework — (String)

      An optional framework specifier. If provided, only networks of this framework type are listed.

      Possible values include:
      • "HYPERLEDGER_FABRIC"
    • Status — (String)

      An optional status specifier. If provided, only networks currently in this status are listed.

      Possible values include:
      • "CREATING"
      • "AVAILABLE"
      • "CREATE_FAILED"
      • "DELETING"
      • "DELETED"
    • MaxResults — (Integer)

      The maximum number of networks to list.

    • NextToken — (String)

      The pagination token that indicates the next set of results to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Networks — (Array<map>)

        An array of NetworkSummary objects that contain configuration properties for each network.

        • Id — (String)

          The unique identifier of the network.

        • Name — (String)

          The name of the network.

        • Description — (String)

          An optional description of the network.

        • Framework — (String)

          The blockchain framework that the network uses.

          Possible values include:
          • "HYPERLEDGER_FABRIC"
        • FrameworkVersion — (String)

          The version of the blockchain framework that the network uses.

        • Status — (String)

          The current status of the network.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "CREATE_FAILED"
          • "DELETING"
          • "DELETED"
        • CreationDate — (Date)

          The date and time that the network was created.

      • NextToken — (String)

        The pagination token that indicates the next set of results to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listNodes(params = {}, callback) ⇒ AWS.Request

Returns information about the nodes within a network.

Service Reference:

Examples:

Calling the listNodes operation

var params = {
  MemberId: 'STRING_VALUE', /* required */
  NetworkId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: CREATING | AVAILABLE | CREATE_FAILED | DELETING | DELETED | FAILED
};
managedblockchain.listNodes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network for which to list nodes.

    • MemberId — (String)

      The unique identifier of the member who owns the nodes to list.

    • Status — (String)

      An optional status specifier. If provided, only nodes currently in this status are listed.

      Possible values include:
      • "CREATING"
      • "AVAILABLE"
      • "CREATE_FAILED"
      • "DELETING"
      • "DELETED"
      • "FAILED"
    • MaxResults — (Integer)

      The maximum number of nodes to list.

    • NextToken — (String)

      The pagination token that indicates the next set of results to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Nodes — (Array<map>)

        An array of NodeSummary objects that contain configuration properties for each node.

        • Id — (String)

          The unique identifier of the node.

        • Status — (String)

          The status of the node.

          Possible values include:
          • "CREATING"
          • "AVAILABLE"
          • "CREATE_FAILED"
          • "DELETING"
          • "DELETED"
          • "FAILED"
        • CreationDate — (Date)

          The date and time that the node was created.

        • AvailabilityZone — (String)

          The Availability Zone in which the node exists.

        • InstanceType — (String)

          The EC2 instance type for the node.

      • NextToken — (String)

        The pagination token that indicates the next set of results to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listProposals(params = {}, callback) ⇒ AWS.Request

Returns a listing of proposals for the network.

Service Reference:

Examples:

Calling the listProposals operation

var params = {
  NetworkId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
managedblockchain.listProposals(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network.

    • MaxResults — (Integer)

      The maximum number of proposals to return.

    • NextToken — (String)

      The pagination token that indicates the next set of results to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Proposals — (Array<map>)

        The summary of each proposal made on the network.

        • ProposalId — (String)

          The unique identifier of the proposal.

        • Description — (String)

          The description of the proposal.

        • ProposedByMemberId — (String)

          The unique identifier of the member that created the proposal.

        • ProposedByMemberName — (String)

          The name of the member that created the proposal.

        • Status — (String)

          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 are not carried out.

          • EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.

          • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.

          Possible values include:
          • "IN_PROGRESS"
          • "APPROVED"
          • "REJECTED"
          • "EXPIRED"
          • "ACTION_FAILED"
        • CreationDate — (Date)

          The date and time that the proposal was created.

        • ExpirationDate — (Date)

          The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.

      • NextToken — (String)

        The pagination token that indicates the next set of results to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listProposalVotes(params = {}, callback) ⇒ AWS.Request

Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

Service Reference:

Examples:

Calling the listProposalVotes operation

var params = {
  NetworkId: 'STRING_VALUE', /* required */
  ProposalId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
managedblockchain.listProposalVotes(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network.

    • ProposalId — (String)

      The unique identifier of the proposal.

    • MaxResults — (Integer)

      The maximum number of votes to return.

    • NextToken — (String)

      The pagination token that indicates the next set of results to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ProposalVotes — (Array<map>)

        The listing of votes.

        • Vote — (String)

          The vote value, either YES or NO.

          Possible values include:
          • "YES"
          • "NO"
        • MemberName — (String)

          The name of the member that cast the vote.

        • MemberId — (String)

          The unique identifier of the member that cast the vote.

      • NextToken — (String)

        The pagination token that indicates the next set of results to retrieve.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

rejectInvitation(params = {}, callback) ⇒ AWS.Request

Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.

Service Reference:

Examples:

Calling the rejectInvitation operation

var params = {
  InvitationId: 'STRING_VALUE' /* required */
};
managedblockchain.rejectInvitation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • InvitationId — (String)

      The unique identifier of the invitation to reject.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

voteOnProposal(params = {}, callback) ⇒ AWS.Request

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 AWS account as the principal that calls the action.

Service Reference:

Examples:

Calling the voteOnProposal operation

var params = {
  NetworkId: 'STRING_VALUE', /* required */
  ProposalId: 'STRING_VALUE', /* required */
  Vote: YES | NO, /* required */
  VoterMemberId: 'STRING_VALUE' /* required */
};
managedblockchain.voteOnProposal(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NetworkId — (String)

      The unique identifier of the network.

    • ProposalId — (String)

      The unique identifier of the proposal.

    • VoterMemberId — (String)

      The unique identifier of the member casting the vote.

    • Vote — (String)

      The value of the vote.

      Possible values include:
      • "YES"
      • "NO"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.