ManagedBlockchain

Client

class ManagedBlockchain.Client

A low-level client representing Amazon Managed Blockchain (ManagedBlockchain)

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.

Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as CreateMember and DeleteMember don't apply to Ethereum.

The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.

client = session.create_client('managedblockchain')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

create_accessor(**kwargs)

Warning

The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.

Creates a new accessor for use with Managed Blockchain Ethereum nodes. An accessor object is a container that has the information required for token based access to your Ethereum nodes.

See also: AWS API Documentation

Request Syntax

response = client.create_accessor(
    ClientRequestToken='string',
    AccessorType='BILLING_TOKEN'
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • AccessorType (string) --

    [REQUIRED]

    The type of accessor.

    Note

    Currently accessor type is restricted to BILLING_TOKEN .

Return type

dict

Returns

Response Syntax

{
    'AccessorId': 'string',
    'BillingToken': 'string'
}

Response Structure

  • (dict) --

    • AccessorId (string) --

      The unique identifier of the accessor.

    • BillingToken (string) --

      The billing token is a property of the Accessor. Use this token to make Ethereum API calls to your Ethereum node. The billing token is used to track your accessor object for billing Ethereum API requests made to your Ethereum nodes.

Exceptions

create_member(**kwargs)

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.create_member(
    ClientRequestToken='string',
    InvitationId='string',
    NetworkId='string',
    MemberConfiguration={
        'Name': 'string',
        'Description': 'string',
        'FrameworkConfiguration': {
            'Fabric': {
                'AdminUsername': 'string',
                'AdminPassword': 'string'
            }
        },
        'LogPublishingConfiguration': {
            'Fabric': {
                'CaLogs': {
                    'Cloudwatch': {
                        'Enabled': True|False
                    }
                }
            }
        },
        'Tags': {
            'string': 'string'
        },
        'KmsKeyArn': 'string'
    }
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • InvitationId (string) --

    [REQUIRED]

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

  • NetworkId (string) --

    [REQUIRED]

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

  • MemberConfiguration (dict) --

    [REQUIRED]

    Member configuration parameters.

    • Name (string) -- [REQUIRED]

      The name of the member.

    • Description (string) --

      An optional description of the member.

    • FrameworkConfiguration (dict) -- [REQUIRED]

      Configuration properties of the blockchain framework relevant to the member.

      • Fabric (dict) --

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

        • AdminUsername (string) -- [REQUIRED]

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

        • AdminPassword (string) -- [REQUIRED]

          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 quotation mark (‘), a double quotation marks (“), a forward slash(/), a backward slash(), @, or a space.

    • LogPublishingConfiguration (dict) --

      Configuration properties for logging events associated with a member of a Managed Blockchain network.

      • Fabric (dict) --

        Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.

        • CaLogs (dict) --

          Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.

          • Cloudwatch (dict) --

            Parameters for publishing logs to Amazon CloudWatch Logs.

            • Enabled (boolean) --

              Indicates whether logging is enabled.

    • Tags (dict) --

      Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

      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.

      • (string) --
        • (string) --
    • KmsKeyArn (string) --

      The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) to use for encryption at rest in the member. This parameter is inherited by any nodes that this member creates. For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

      Use one of the following options to specify this parameter:

      • Undefined or empty string - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf.
      • A valid symmetric customer managed KMS key - Use the specified KMS key in your account that you create, own, and manage. Amazon Managed Blockchain doesn't support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide . The following is an example of a KMS key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Return type

dict

Returns

Response Syntax

{
    'MemberId': 'string'
}

Response Structure

  • (dict) --

    • MemberId (string) --

      The unique identifier of the member.

Exceptions

create_network(**kwargs)

Creates a new blockchain network using Amazon Managed Blockchain.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.create_network(
    ClientRequestToken='string',
    Name='string',
    Description='string',
    Framework='HYPERLEDGER_FABRIC'|'ETHEREUM',
    FrameworkVersion='string',
    FrameworkConfiguration={
        'Fabric': {
            'Edition': 'STARTER'|'STANDARD'
        }
    },
    VotingPolicy={
        'ApprovalThresholdPolicy': {
            'ThresholdPercentage': 123,
            'ProposalDurationInHours': 123,
            'ThresholdComparator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUAL_TO'
        }
    },
    MemberConfiguration={
        'Name': 'string',
        'Description': 'string',
        'FrameworkConfiguration': {
            'Fabric': {
                'AdminUsername': 'string',
                'AdminPassword': 'string'
            }
        },
        'LogPublishingConfiguration': {
            'Fabric': {
                'CaLogs': {
                    'Cloudwatch': {
                        'Enabled': True|False
                    }
                }
            }
        },
        'Tags': {
            'string': 'string'
        },
        'KmsKeyArn': 'string'
    },
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • Name (string) --

    [REQUIRED]

    The name of the network.

  • Description (string) -- An optional description for the network.
  • Framework (string) --

    [REQUIRED]

    The blockchain framework that the network uses.

  • FrameworkVersion (string) --

    [REQUIRED]

    The version of the blockchain framework that the network uses.

  • FrameworkConfiguration (dict) --

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

    • Fabric (dict) --

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

  • VotingPolicy (dict) --

    [REQUIRED]

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

    • ApprovalThresholdPolicy (dict) --

      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 aren't 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.

  • MemberConfiguration (dict) --

    [REQUIRED]

    Configuration properties for the first member within the network.

    • Name (string) -- [REQUIRED]

      The name of the member.

    • Description (string) --

      An optional description of the member.

    • FrameworkConfiguration (dict) -- [REQUIRED]

      Configuration properties of the blockchain framework relevant to the member.

      • Fabric (dict) --

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

        • AdminUsername (string) -- [REQUIRED]

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

        • AdminPassword (string) -- [REQUIRED]

          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 quotation mark (‘), a double quotation marks (“), a forward slash(/), a backward slash(), @, or a space.

    • LogPublishingConfiguration (dict) --

      Configuration properties for logging events associated with a member of a Managed Blockchain network.

      • Fabric (dict) --

        Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.

        • CaLogs (dict) --

          Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.

          • Cloudwatch (dict) --

            Parameters for publishing logs to Amazon CloudWatch Logs.

            • Enabled (boolean) --

              Indicates whether logging is enabled.

    • Tags (dict) --

      Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

      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.

      • (string) --
        • (string) --
    • KmsKeyArn (string) --

      The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) to use for encryption at rest in the member. This parameter is inherited by any nodes that this member creates. For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

      Use one of the following options to specify this parameter:

      • Undefined or empty string - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf.
      • A valid symmetric customer managed KMS key - Use the specified KMS key in your account that you create, own, and manage. Amazon Managed Blockchain doesn't support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide . The following is an example of a KMS key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
  • Tags (dict) --

    Tags to assign to the network. Each tag consists of a key and optional value.

    When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

    For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'NetworkId': 'string',
    'MemberId': 'string'
}

Response Structure

  • (dict) --

    • NetworkId (string) --

      The unique identifier for the network.

    • MemberId (string) --

      The unique identifier for the first member within the network.

Exceptions

create_node(**kwargs)

Creates a node on the specified blockchain network.

Applies to Hyperledger Fabric and Ethereum.

See also: AWS API Documentation

Request Syntax

response = client.create_node(
    ClientRequestToken='string',
    NetworkId='string',
    MemberId='string',
    NodeConfiguration={
        'InstanceType': 'string',
        'AvailabilityZone': 'string',
        'LogPublishingConfiguration': {
            'Fabric': {
                'ChaincodeLogs': {
                    'Cloudwatch': {
                        'Enabled': True|False
                    }
                },
                'PeerLogs': {
                    'Cloudwatch': {
                        'Enabled': True|False
                    }
                }
            }
        },
        'StateDB': 'LevelDB'|'CouchDB'
    },
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network for the node.

    Ethereum public networks have the following NetworkId s:

    • n-ethereum-mainnet
    • n-ethereum-goerli
    • n-ethereum-rinkeby
    • n-ethereum-ropsten
  • MemberId (string) --

    The unique identifier of the member that owns this node.

    Applies only to Hyperledger Fabric.

  • NodeConfiguration (dict) --

    [REQUIRED]

    The properties of a node configuration.

    • InstanceType (string) -- [REQUIRED]

      The Amazon Managed Blockchain instance type for the node.

    • AvailabilityZone (string) --

      The Availability Zone in which the node exists. Required for Ethereum nodes.

    • LogPublishingConfiguration (dict) --

      Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

      • Fabric (dict) --

        Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.

        • ChaincodeLogs (dict) --

          Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.

          • Cloudwatch (dict) --

            Parameters for publishing logs to Amazon CloudWatch Logs.

            • Enabled (boolean) --

              Indicates whether logging is enabled.

        • PeerLogs (dict) --

          Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.

          • Cloudwatch (dict) --

            Parameters for publishing logs to Amazon CloudWatch Logs.

            • Enabled (boolean) --

              Indicates whether logging is enabled.

    • StateDB (string) --

      The state database that the node uses. Values are LevelDB or CouchDB . When using an Amazon Managed Blockchain network with Hyperledger Fabric version 1.4 or later, the default is CouchDB .

      Applies only to Hyperledger Fabric.

  • Tags (dict) --

    Tags to assign to the node. Each tag consists of a key and optional value.

    When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

    For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'NodeId': 'string'
}

Response Structure

  • (dict) --

    • NodeId (string) --

      The unique identifier of the node.

Exceptions

create_proposal(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_proposal(
    ClientRequestToken='string',
    NetworkId='string',
    MemberId='string',
    Actions={
        'Invitations': [
            {
                'Principal': 'string'
            },
        ],
        'Removals': [
            {
                'MemberId': 'string'
            },
        ]
    },
    Description='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ClientRequestToken (string) --

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • NetworkId (string) --

    [REQUIRED]

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

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single Amazon Web Services account.

  • Actions (dict) --

    [REQUIRED]

    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 (list) --

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

      • (dict) --

        An action to invite a specific Amazon Web Services account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED .

        Applies only to Hyperledger Fabric.

        • Principal (string) -- [REQUIRED]

          The Amazon Web Services account ID to invite.

    • Removals (list) --

      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.

      • (dict) --

        An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED . The member and all associated resources are deleted from the network.

        Applies only to Hyperledger Fabric.

        • MemberId (string) -- [REQUIRED]

          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."
  • Tags (dict) --

    Tags to assign to the proposal. Each tag consists 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. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.

    For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'ProposalId': 'string'
}

Response Structure

  • (dict) --

    • ProposalId (string) --

      The unique identifier of the proposal.

Exceptions

delete_accessor(**kwargs)

Warning

The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.

Deletes an accessor that your Amazon Web Services account owns. An accessor object is a container that has the information required for token based access to your Ethereum nodes including, the BILLING_TOKEN . After an accessor is deleted, the status of the accessor changes from AVAILABLE to PENDING_DELETION . An accessor in the PENDING_DELETION state can’t be used for new WebSocket requests or HTTP requests. However, WebSocket connections that were initiated while the accessor was in the AVAILABLE state remain open until they expire (up to 2 hours).

See also: AWS API Documentation

Request Syntax

response = client.delete_accessor(
    AccessorId='string'
)
Parameters
AccessorId (string) --

[REQUIRED]

The unique identifier of the accessor.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

delete_member(**kwargs)

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the Amazon Web Services account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last Amazon Web Services account, the network is deleted also.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.delete_member(
    NetworkId='string',
    MemberId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

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

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member to remove.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

delete_node(**kwargs)

Deletes a node that your Amazon Web Services account owns. All data on the node is lost and cannot be recovered.

Applies to Hyperledger Fabric and Ethereum.

See also: AWS API Documentation

Request Syntax

response = client.delete_node(
    NetworkId='string',
    MemberId='string',
    NodeId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

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

    Ethereum public networks have the following NetworkId s:

    • n-ethereum-mainnet
    • n-ethereum-goerli
    • n-ethereum-rinkeby
    • n-ethereum-ropsten
  • MemberId (string) --

    The unique identifier of the member that owns this node.

    Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

  • NodeId (string) --

    [REQUIRED]

    The unique identifier of the node.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

get_accessor(**kwargs)

Warning

The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.

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.

See also: AWS API Documentation

Request Syntax

response = client.get_accessor(
    AccessorId='string'
)
Parameters
AccessorId (string) --

[REQUIRED]

The unique identifier of the accessor.

Return type
dict
Returns
Response Syntax
{
    'Accessor': {
        'Id': 'string',
        'Type': 'BILLING_TOKEN',
        'BillingToken': 'string',
        'Status': 'AVAILABLE'|'PENDING_DELETION'|'DELETED',
        'CreationDate': datetime(2015, 1, 1),
        'Arn': 'string'
    }
}

Response Structure

  • (dict) --
    • Accessor (dict) --

      The properties of the accessor.

      • Id (string) --

        The unique identifier of the accessor.

      • Type (string) --

        The type of the accessor.

        Note

        Currently accessor type is restricted to BILLING_TOKEN .

      • BillingToken (string) --

        The billing token is a property of the accessor. Use this token to make Ethereum API calls to your Ethereum node. The billing token is used to track your accessor object for billing Ethereum API requests made to your Ethereum nodes.

      • Status (string) --

        The current status of the accessor.

      • CreationDate (datetime) --

        The creation date and time of the accessor.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

Exceptions

get_member(**kwargs)

Returns detailed information about a member.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.get_member(
    NetworkId='string',
    MemberId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

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

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member.

Return type

dict

Returns

Response Syntax

{
    'Member': {
        'NetworkId': 'string',
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'FrameworkAttributes': {
            'Fabric': {
                'AdminUsername': 'string',
                'CaEndpoint': 'string'
            }
        },
        'LogPublishingConfiguration': {
            'Fabric': {
                'CaLogs': {
                    'Cloudwatch': {
                        'Enabled': True|False
                    }
                }
            }
        },
        'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'INACCESSIBLE_ENCRYPTION_KEY',
        'CreationDate': datetime(2015, 1, 1),
        'Tags': {
            'string': 'string'
        },
        'Arn': 'string',
        'KmsKeyArn': 'string'
    }
}

Response Structure

  • (dict) --

    • Member (dict) --

      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 (dict) --

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

        • Fabric (dict) --

          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.

      • LogPublishingConfiguration (dict) --

        Configuration properties for logging events associated with a member.

        • Fabric (dict) --

          Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.

          • CaLogs (dict) --

            Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.

            • Cloudwatch (dict) --

              Parameters for publishing logs to Amazon CloudWatch Logs.

              • Enabled (boolean) --

                Indicates whether logging is enabled.

      • Status (string) --

        The status of a member.

        • CREATING - The Amazon Web Services account is in the process of creating a member.
        • AVAILABLE - The member has been created and can participate in the network.
        • CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.
        • UPDATING - The member is in the process of being updated.
        • DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
        • DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
        • INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked. The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.
      • CreationDate (datetime) --

        The date and time that the member was created.

      • Tags (dict) --

        Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

        • (string) --
          • (string) --
      • Arn (string) --

        The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

      • KmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the member uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key" , the member uses an Amazon Web Services owned KMS key for encryption. This parameter is inherited by the nodes that this member owns.

        For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

Exceptions

get_network(**kwargs)

Returns detailed information about a network.

Applies to Hyperledger Fabric and Ethereum.

See also: AWS API Documentation

Request Syntax

response = client.get_network(
    NetworkId='string'
)
Parameters
NetworkId (string) --

[REQUIRED]

The unique identifier of the network to get information about.

Return type
dict
Returns
Response Syntax
{
    'Network': {
        'Id': 'string',
        'Name': 'string',
        'Description': 'string',
        'Framework': 'HYPERLEDGER_FABRIC'|'ETHEREUM',
        'FrameworkVersion': 'string',
        'FrameworkAttributes': {
            'Fabric': {
                'OrderingServiceEndpoint': 'string',
                'Edition': 'STARTER'|'STANDARD'
            },
            'Ethereum': {
                'ChainId': 'string'
            }
        },
        'VpcEndpointServiceName': 'string',
        'VotingPolicy': {
            'ApprovalThresholdPolicy': {
                'ThresholdPercentage': 123,
                'ProposalDurationInHours': 123,
                'ThresholdComparator': 'GREATER_THAN'|'GREATER_THAN_OR_EQUAL_TO'
            }
        },
        'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
        'CreationDate': datetime(2015, 1, 1),
        'Tags': {
            'string': 'string'
        },
        'Arn': 'string'
    }
}

Response Structure

  • (dict) --
    • Network (dict) --

      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.

      • FrameworkVersion (string) --

        The version of the blockchain framework that the network uses.

      • FrameworkAttributes (dict) --

        Attributes of the blockchain framework that the network uses.

        • Fabric (dict) --

          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.

        • Ethereum (dict) --

          Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network.

          • ChainId (string) --

            The Ethereum CHAIN_ID associated with the Ethereum network. Chain IDs are as follows:

            • mainnet = 1
            • goerli = 5
            • rinkeby = 4
            • ropsten = 3
      • 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 (dict) --

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

        • ApprovalThresholdPolicy (dict) --

          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 aren't 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.

      • Status (string) --

        The current status of the network.

      • CreationDate (datetime) --

        The date and time that the network was created.

      • Tags (dict) --

        Tags assigned to the network. Each tag consists of a key and optional value.

        For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

        • (string) --
          • (string) --
      • Arn (string) --

        The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

Exceptions

get_node(**kwargs)

Returns detailed information about a node.

Applies to Hyperledger Fabric and Ethereum.

See also: AWS API Documentation

Request Syntax

response = client.get_node(
    NetworkId='string',
    MemberId='string',
    NodeId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

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

  • MemberId (string) --

    The unique identifier of the member that owns the node.

    Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

  • NodeId (string) --

    [REQUIRED]

    The unique identifier of the node.

Return type

dict

Returns

Response Syntax

{
    'Node': {
        'NetworkId': 'string',
        'MemberId': 'string',
        'Id': 'string',
        'InstanceType': 'string',
        'AvailabilityZone': 'string',
        'FrameworkAttributes': {
            'Fabric': {
                'PeerEndpoint': 'string',
                'PeerEventEndpoint': 'string'
            },
            'Ethereum': {
                'HttpEndpoint': 'string',
                'WebSocketEndpoint': 'string'
            }
        },
        'LogPublishingConfiguration': {
            'Fabric': {
                'ChaincodeLogs': {
                    'Cloudwatch': {
                        'Enabled': True|False
                    }
                },
                'PeerLogs': {
                    'Cloudwatch': {
                        'Enabled': True|False
                    }
                }
            }
        },
        'StateDB': 'LevelDB'|'CouchDB',
        'Status': 'CREATING'|'AVAILABLE'|'UNHEALTHY'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'INACCESSIBLE_ENCRYPTION_KEY',
        'CreationDate': datetime(2015, 1, 1),
        'Tags': {
            'string': 'string'
        },
        'Arn': 'string',
        'KmsKeyArn': 'string'
    }
}

Response Structure

  • (dict) --

    • Node (dict) --

      Properties of the node configuration.

      • NetworkId (string) --

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

      • MemberId (string) --

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

        Applies only to Hyperledger Fabric.

      • 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. Required for Ethereum nodes.

      • FrameworkAttributes (dict) --

        Attributes of the blockchain framework being used.

        • Fabric (dict) --

          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.

        • Ethereum (dict) --

          Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum.

          • HttpEndpoint (string) --

            The endpoint on which the Ethereum node listens to run Ethereum API methods over HTTP connections from a client. Use this endpoint in client code for smart contracts when using an HTTP connection. Connections to this endpoint are authenticated using Signature Version 4.

          • WebSocketEndpoint (string) --

            The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over WebSocket connections from a client. Use this endpoint in client code for smart contracts when using a WebSocket connection. Connections to this endpoint are authenticated using Signature Version 4.

      • LogPublishingConfiguration (dict) --

        Configuration properties for logging events associated with a peer node on a Hyperledger Fabric network on Managed Blockchain.

        • Fabric (dict) --

          Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.

          • ChaincodeLogs (dict) --

            Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.

            • Cloudwatch (dict) --

              Parameters for publishing logs to Amazon CloudWatch Logs.

              • Enabled (boolean) --

                Indicates whether logging is enabled.

          • PeerLogs (dict) --

            Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.

            • Cloudwatch (dict) --

              Parameters for publishing logs to Amazon CloudWatch Logs.

              • Enabled (boolean) --

                Indicates whether logging is enabled.

      • StateDB (string) --

        The state database that the node uses. Values are LevelDB or CouchDB .

        Applies only to Hyperledger Fabric.

      • Status (string) --

        The status of the node.

        • CREATING - The Amazon Web Services account is in the process of creating a node.
        • AVAILABLE - The node has been created and can participate in the network.
        • UNHEALTHY - The node is impaired and might not function as expected. Amazon Managed Blockchain automatically finds nodes in this state and tries to recover them. If a node is recoverable, it returns to AVAILABLE . Otherwise, it moves to FAILED status.
        • CREATE_FAILED - The Amazon Web Services account attempted to create a node and creation failed.
        • UPDATING - The node is in the process of being updated.
        • DELETING - The node is in the process of being deleted.
        • DELETED - The node can no longer participate on the network.
        • FAILED - The node is no longer functional, cannot be recovered, and must be deleted.
        • INACCESSIBLE_ENCRYPTION_KEY - The node is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked. The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the node resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.
      • CreationDate (datetime) --

        The date and time that the node was created.

      • Tags (dict) --

        Tags assigned to the node. Each tag consists of a key and optional value.

        For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

        • (string) --
          • (string) --
      • Arn (string) --

        The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

      • KmsKeyArn (string) --

        The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the node uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key" , the node uses an Amazon Web Services owned KMS key for encryption. The node inherits this parameter from the member that it belongs to.

        For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

        Applies only to Hyperledger Fabric.

Exceptions

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_proposal(**kwargs)

Returns detailed information about a proposal.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.get_proposal(
    NetworkId='string',
    ProposalId='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

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

  • ProposalId (string) --

    [REQUIRED]

    The unique identifier of the proposal.

Return type

dict

Returns

Response Syntax

{
    'Proposal': {
        'ProposalId': 'string',
        'NetworkId': 'string',
        'Description': 'string',
        'Actions': {
            'Invitations': [
                {
                    'Principal': 'string'
                },
            ],
            'Removals': [
                {
                    'MemberId': 'string'
                },
            ]
        },
        'ProposedByMemberId': 'string',
        'ProposedByMemberName': 'string',
        'Status': 'IN_PROGRESS'|'APPROVED'|'REJECTED'|'EXPIRED'|'ACTION_FAILED',
        'CreationDate': datetime(2015, 1, 1),
        'ExpirationDate': datetime(2015, 1, 1),
        'YesVoteCount': 123,
        'NoVoteCount': 123,
        'OutstandingVoteCount': 123,
        'Tags': {
            'string': 'string'
        },
        'Arn': 'string'
    }
}

Response Structure

  • (dict) --

    • Proposal (dict) --

      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 (dict) --

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

        • Invitations (list) --

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

          • (dict) --

            An action to invite a specific Amazon Web Services account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED .

            Applies only to Hyperledger Fabric.

            • Principal (string) --

              The Amazon Web Services account ID to invite.

        • Removals (list) --

          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.

          • (dict) --

            An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED . The member and all associated resources are deleted from the network.

            Applies only to Hyperledger Fabric.

            • MemberId (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 aren't carried out.
        • EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.
        • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error. The ACTION_FAILED status occurs even if only one ProposalAction fails and other actions are successful.
      • CreationDate (datetime) --

        The date and time that the proposal was created.

      • ExpirationDate (datetime) --

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

      • 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.

      • Tags (dict) --

        Tags assigned to the proposal. Each tag consists of a key and optional value.

        For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

        • (string) --
          • (string) --
      • Arn (string) --

        The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

Exceptions

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
list_accessors(**kwargs)

Warning

The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.

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.

See also: AWS API Documentation

Request Syntax

response = client.list_accessors(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of accessors to list.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Accessors': [
        {
            'Id': 'string',
            'Type': 'BILLING_TOKEN',
            'Status': 'AVAILABLE'|'PENDING_DELETION'|'DELETED',
            'CreationDate': datetime(2015, 1, 1),
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Accessors (list) --

      An array of AccessorSummary objects that contain configuration properties for each accessor.

      • (dict) --

        Warning

        The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.

        A summary of accessor properties.

        • Id (string) --

          The unique identifier of the accessor.

        • Type (string) --

          The type of the accessor.

          Note

          Currently accessor type is restricted to BILLING_TOKEN .

        • Status (string) --

          The current status of the accessor.

        • CreationDate (datetime) --

          The creation date and time of the accessor.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

    • NextToken (string) --

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

Exceptions

list_invitations(**kwargs)

Returns a list of all invitations for the current Amazon Web Services account.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.list_invitations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of invitations to return.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Invitations': [
        {
            'InvitationId': 'string',
            'CreationDate': datetime(2015, 1, 1),
            'ExpirationDate': datetime(2015, 1, 1),
            'Status': 'PENDING'|'ACCEPTED'|'ACCEPTING'|'REJECTED'|'EXPIRED',
            'NetworkSummary': {
                'Id': 'string',
                'Name': 'string',
                'Description': 'string',
                'Framework': 'HYPERLEDGER_FABRIC'|'ETHEREUM',
                'FrameworkVersion': 'string',
                'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
                'CreationDate': datetime(2015, 1, 1),
                'Arn': 'string'
            },
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Invitations (list) --

      The invitations for the network.

      • (dict) --

        An invitation to an Amazon Web Services account to create a member and join the network.

        Applies only to Hyperledger Fabric.

        • InvitationId (string) --

          The unique identifier for the invitation.

        • CreationDate (datetime) --

          The date and time that the invitation was created.

        • ExpirationDate (datetime) --

          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 hasn't created a member to join the network, and the invitation hasn't yet expired.
          • ACCEPTING - The invitee has begun creating a member, and creation hasn't yet completed.
          • ACCEPTED - The invitee created a member and joined the network using the InvitationID .
          • REJECTED - The invitee rejected the invitation.
          • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate .
        • NetworkSummary (dict) --

          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.

          • FrameworkVersion (string) --

            The version of the blockchain framework that the network uses.

          • Status (string) --

            The current status of the network.

          • CreationDate (datetime) --

            The date and time that the network was created.

          • Arn (string) --

            The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

        • Arn (string) --

          The Amazon Resource Name (ARN) of the invitation. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

    • NextToken (string) --

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

Exceptions

list_members(**kwargs)

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

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.list_members(
    NetworkId='string',
    Name='string',
    Status='CREATING'|'AVAILABLE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'INACCESSIBLE_ENCRYPTION_KEY',
    IsOwned=True|False,
    MaxResults=123,
    NextToken='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    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.
  • IsOwned (boolean) -- An optional Boolean value. If provided, the request is limited either to members that the current Amazon Web Services account owns ( true ) or that other Amazon Web Services accountsn own ( false ). If omitted, all members are listed.
  • 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.
Return type

dict

Returns

Response Syntax

{
    'Members': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'INACCESSIBLE_ENCRYPTION_KEY',
            'CreationDate': datetime(2015, 1, 1),
            'IsOwned': True|False,
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Members (list) --

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

      • (dict) --

        A summary of configuration properties for a member.

        Applies only to Hyperledger Fabric.

        • 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 Amazon Web Services account is in the process of creating a member.
          • AVAILABLE - The member has been created and can participate in the network.
          • CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.
          • UPDATING - The member is in the process of being updated.
          • DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
          • DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.
          • INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in Key Management Service (KMS) for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked. The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.
        • CreationDate (datetime) --

          The date and time that the member was created.

        • IsOwned (boolean) --

          An indicator of whether the member is owned by your Amazon Web Services account or a different Amazon Web Services account.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

    • NextToken (string) --

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

Exceptions

list_networks(**kwargs)

Returns information about the networks in which the current Amazon Web Services account participates.

Applies to Hyperledger Fabric and Ethereum.

See also: AWS API Documentation

Request Syntax

response = client.list_networks(
    Name='string',
    Framework='HYPERLEDGER_FABRIC'|'ETHEREUM',
    Status='CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • Name (string) -- The name of the network.
  • Framework (string) -- An optional framework specifier. If provided, only networks of this framework type are listed.
  • Status (string) --

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

    Applies only to Hyperledger Fabric.

  • MaxResults (integer) -- The maximum number of networks to list.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Networks': [
        {
            'Id': 'string',
            'Name': 'string',
            'Description': 'string',
            'Framework': 'HYPERLEDGER_FABRIC'|'ETHEREUM',
            'FrameworkVersion': 'string',
            'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
            'CreationDate': datetime(2015, 1, 1),
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Networks (list) --

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

      • (dict) --

        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.

        • FrameworkVersion (string) --

          The version of the blockchain framework that the network uses.

        • Status (string) --

          The current status of the network.

        • CreationDate (datetime) --

          The date and time that the network was created.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

    • NextToken (string) --

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

Exceptions

list_nodes(**kwargs)

Returns information about the nodes within a network.

Applies to Hyperledger Fabric and Ethereum.

See also: AWS API Documentation

Request Syntax

response = client.list_nodes(
    NetworkId='string',
    MemberId='string',
    Status='CREATING'|'AVAILABLE'|'UNHEALTHY'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'INACCESSIBLE_ENCRYPTION_KEY',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    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.

    Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.

  • Status (string) -- An optional status specifier. If provided, only nodes currently in this status are listed.
  • MaxResults (integer) -- The maximum number of nodes to list.
  • NextToken (string) -- The pagination token that indicates the next set of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'Nodes': [
        {
            'Id': 'string',
            'Status': 'CREATING'|'AVAILABLE'|'UNHEALTHY'|'CREATE_FAILED'|'UPDATING'|'DELETING'|'DELETED'|'FAILED'|'INACCESSIBLE_ENCRYPTION_KEY',
            'CreationDate': datetime(2015, 1, 1),
            'AvailabilityZone': 'string',
            'InstanceType': 'string',
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Nodes (list) --

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

      • (dict) --

        A summary of configuration properties for a node.

        • Id (string) --

          The unique identifier of the node.

        • Status (string) --

          The status of the node.

        • CreationDate (datetime) --

          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.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the node. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

    • NextToken (string) --

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

Exceptions

list_proposal_votes(**kwargs)

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

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.list_proposal_votes(
    NetworkId='string',
    ProposalId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network.

  • ProposalId (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'ProposalVotes': [
        {
            'Vote': 'YES'|'NO',
            'MemberName': 'string',
            'MemberId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ProposalVotes (list) --

      The list of votes.

      • (dict) --

        Properties of an individual vote that a member cast for a proposal.

        Applies only to Hyperledger Fabric.

        • Vote (string) --

          The vote value, either YES or 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.

Exceptions

list_proposals(**kwargs)

Returns a list of proposals for the network.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.list_proposals(
    NetworkId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    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.
Return type

dict

Returns

Response Syntax

{
    'Proposals': [
        {
            'ProposalId': 'string',
            'Description': 'string',
            'ProposedByMemberId': 'string',
            'ProposedByMemberName': 'string',
            'Status': 'IN_PROGRESS'|'APPROVED'|'REJECTED'|'EXPIRED'|'ACTION_FAILED',
            'CreationDate': datetime(2015, 1, 1),
            'ExpirationDate': datetime(2015, 1, 1),
            'Arn': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Proposals (list) --

      The summary of each proposal made on the network.

      • (dict) --

        Properties of a proposal.

        Applies only to Hyperledger Fabric.

        • 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 aren't carried out.
          • EXPIRED - Members didn't cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions aren't carried out.
          • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved couldn't be completed because of an error.
        • CreationDate (datetime) --

          The date and time that the proposal was created.

        • ExpirationDate (datetime) --

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

        • Arn (string) --

          The Amazon Resource Name (ARN) of the proposal. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

    • NextToken (string) --

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

Exceptions

list_tags_for_resource(**kwargs)

Returns a list of tags for the specified resource. Each tag consists of a key and optional value.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The tags assigned to the resource.

      • (string) --
        • (string) --

Exceptions

reject_invitation(**kwargs)

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

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.reject_invitation(
    InvitationId='string'
)
Parameters
InvitationId (string) --

[REQUIRED]

The unique identifier of the invitation to reject.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

tag_resource(**kwargs)

Adds or overwrites the specified tags for the specified Amazon Managed Blockchain resource. Each tag consists of a key and optional value.

When you specify a tag key that already exists, the tag value is overwritten with the new value. Use UntagResource to remove tag keys.

A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

  • Tags (dict) --

    [REQUIRED]

    The tags to assign to the specified resource. Tag values can be empty, for example, "MyTagKey" : "" . You can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

untag_resource(**kwargs)

Removes the specified tags from the Amazon Managed Blockchain resource.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide , or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide .

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the resource. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .

  • TagKeys (list) --

    [REQUIRED]

    The tag keys.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_member(**kwargs)

Updates a member configuration with new parameters.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.update_member(
    NetworkId='string',
    MemberId='string',
    LogPublishingConfiguration={
        'Fabric': {
            'CaLogs': {
                'Cloudwatch': {
                    'Enabled': True|False
                }
            }
        }
    }
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

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

  • MemberId (string) --

    [REQUIRED]

    The unique identifier of the member.

  • LogPublishingConfiguration (dict) --

    Configuration properties for publishing to Amazon CloudWatch Logs.

    • Fabric (dict) --

      Configuration properties for logging events associated with a member of a Managed Blockchain network using the Hyperledger Fabric framework.

      • CaLogs (dict) --

        Configuration properties for logging events associated with a member's Certificate Authority (CA). CA logs help you determine when a member in your account joins the network, or when new peers register with a member CA.

        • Cloudwatch (dict) --

          Parameters for publishing logs to Amazon CloudWatch Logs.

          • Enabled (boolean) --

            Indicates whether logging is enabled.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

update_node(**kwargs)

Updates a node configuration with new parameters.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.update_node(
    NetworkId='string',
    MemberId='string',
    NodeId='string',
    LogPublishingConfiguration={
        'Fabric': {
            'ChaincodeLogs': {
                'Cloudwatch': {
                    'Enabled': True|False
                }
            },
            'PeerLogs': {
                'Cloudwatch': {
                    'Enabled': True|False
                }
            }
        }
    }
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

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

  • MemberId (string) --

    The unique identifier of the member that owns the node.

    Applies only to Hyperledger Fabric.

  • NodeId (string) --

    [REQUIRED]

    The unique identifier of the node.

  • LogPublishingConfiguration (dict) --

    Configuration properties for publishing to Amazon CloudWatch Logs.

    • Fabric (dict) --

      Configuration properties for logging events associated with a node that is owned by a member of a Managed Blockchain network using the Hyperledger Fabric framework.

      • ChaincodeLogs (dict) --

        Configuration properties for logging events associated with chaincode execution on a peer node. Chaincode logs contain the results of instantiating, invoking, and querying the chaincode. A peer can run multiple instances of chaincode. When enabled, a log stream is created for all chaincodes, with an individual log stream for each chaincode.

        • Cloudwatch (dict) --

          Parameters for publishing logs to Amazon CloudWatch Logs.

          • Enabled (boolean) --

            Indicates whether logging is enabled.

      • PeerLogs (dict) --

        Configuration properties for a peer node log. Peer node logs contain messages generated when your client submits transaction proposals to peer nodes, requests to join channels, enrolls an admin peer, and lists the chaincode instances on a peer node.

        • Cloudwatch (dict) --

          Parameters for publishing logs to Amazon CloudWatch Logs.

          • Enabled (boolean) --

            Indicates whether logging is enabled.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

vote_on_proposal(**kwargs)

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId , must be in the same Amazon Web Services account as the principal that calls the action.

Applies only to Hyperledger Fabric.

See also: AWS API Documentation

Request Syntax

response = client.vote_on_proposal(
    NetworkId='string',
    ProposalId='string',
    VoterMemberId='string',
    Vote='YES'|'NO'
)
Parameters
  • NetworkId (string) --

    [REQUIRED]

    The unique identifier of the network.

  • ProposalId (string) --

    [REQUIRED]

    The unique identifier of the proposal.

  • VoterMemberId (string) --

    [REQUIRED]

    The unique identifier of the member casting the vote.

  • Vote (string) --

    [REQUIRED]

    The value of the vote.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

Client Exceptions

Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.

The available client exceptions are:

class ManagedBlockchain.Client.exceptions.AccessDeniedException

You don't have sufficient access to perform this action.

Example

try:
  ...
except client.exceptions.AccessDeniedException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    You don't have sufficient access to perform this action.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.IllegalActionException

Example

try:
  ...
except client.exceptions.IllegalActionException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.InternalServiceErrorException

The request processing has failed because of an unknown error, exception or failure.

Example

try:
  ...
except client.exceptions.InternalServiceErrorException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The request processing has failed because of an unknown error, exception or failure.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.InvalidRequestException

The action or operation requested is invalid. Verify that the action is typed correctly.

Example

try:
  ...
except client.exceptions.InvalidRequestException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The action or operation requested is invalid. Verify that the action is typed correctly.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.ResourceAlreadyExistsException

A resource request is issued for a resource that already exists.

Example

try:
  ...
except client.exceptions.ResourceAlreadyExistsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A resource request is issued for a resource that already exists.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.ResourceLimitExceededException

The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.

Example

try:
  ...
except client.exceptions.ResourceLimitExceededException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.ResourceNotFoundException

A requested resource doesn't exist. It may have been deleted or referenced incorrectly.

Example

try:
  ...
except client.exceptions.ResourceNotFoundException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    A requested resource doesn't exist. It may have been deleted or referenced incorrectly.

    • Message (string) --

    • ResourceName (string) --

      A requested resource doesn't exist. It may have been deleted or referenced inaccurately.

    • Error (dict) -- Normalized access to common exception attributes.

      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.ResourceNotReadyException

The requested resource exists but isn't in a status that can complete the operation.

Example

try:
  ...
except client.exceptions.ResourceNotReadyException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --

    The requested resource exists but isn't in a status that can complete the operation.

    • Message (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.ThrottlingException

The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.

Example

try:
  ...
except client.exceptions.ThrottlingException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{}

Structure

  • (dict) --

    The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.

    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.
class ManagedBlockchain.Client.exceptions.TooManyTagsException

Example

try:
  ...
except client.exceptions.TooManyTagsException as e:
  print(e.response)
response

The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.

Syntax

{
    'Message': 'string',
    'ResourceName': 'string',
    'Error': {
        'Code': 'string',
        'Message': 'string'
    }
}

Structure

  • (dict) --
    • Message (string) --
    • ResourceName (string) --
    • Error (dict) -- Normalized access to common exception attributes.
      • Code (string) -- An identifier specifying the exception type.
      • Message (string) -- A descriptive message explaining why the exception occured.

Paginators

The available paginators are:

class ManagedBlockchain.Paginator.ListAccessors
paginator = client.get_paginator('list_accessors')
paginate(**kwargs)

Creates an iterator that will paginate through responses from ManagedBlockchain.Client.list_accessors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Accessors': [
        {
            'Id': 'string',
            'Type': 'BILLING_TOKEN',
            'Status': 'AVAILABLE'|'PENDING_DELETION'|'DELETED',
            'CreationDate': datetime(2015, 1, 1),
            'Arn': 'string'
        },
    ],

}

Response Structure

  • (dict) --
    • Accessors (list) --

      An array of AccessorSummary objects that contain configuration properties for each accessor.

      • (dict) --

        Warning

        The token based access feature is in preview release for Ethereum on Amazon Managed Blockchain and is subject to change. We recommend that you use this feature only with test scenarios, and not in production environments.

        A summary of accessor properties.

        • Id (string) --

          The unique identifier of the accessor.

        • Type (string) --

          The type of the accessor.

          Note

          Currently accessor type is restricted to BILLING_TOKEN .

        • Status (string) --

          The current status of the accessor.

        • CreationDate (datetime) --

          The creation date and time of the accessor.

        • Arn (string) --

          The Amazon Resource Name (ARN) of the accessor. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference .