You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ManagedBlockchain::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::SharedCredentials - Used for loading credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :region (required, String)

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is search for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :client_side_monitoring (Boolean) — default: false

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1"

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the :logger at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String)

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15

    The number of seconds to wait when opening a HTTP session before rasing a Timeout::Error.

  • :http_read_timeout (Integer) — default: 60

    The default number of seconds to wait for response data. This value can safely be set per-request on the session yeidled by #session_for.

  • :http_idle_timeout (Float) — default: 5

    The number of seconds a connection is allowed to sit idble before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session yeidled by #session_for.

  • :http_wire_trace (Boolean) — default: false

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String)

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String)

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



251
252
253
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 251

def initialize(*args)
  super
end

Instance Method Details

#create_member(params = {}) ⇒ Types::CreateMemberOutput

Creates a member within a Managed Blockchain network.

Examples:

Request syntax with placeholder values


resp = client.create_member({
  client_request_token: "ClientRequestTokenString", # required
  invitation_id: "ResourceIdString", # required
  network_id: "ResourceIdString", # required
  member_configuration: { # required
    name: "NetworkMemberNameString", # required
    description: "DescriptionString",
    framework_configuration: { # required
      fabric: {
        admin_username: "UsernameString", # required
        admin_password: "PasswordString", # required
      },
    },
  },
})

Response structure


resp.member_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_request_token (required, String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :invitation_id (required, String)

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

  • :network_id (required, String)

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

  • :member_configuration (required, Types::MemberConfiguration)

    Member configuration parameters.

Returns:

See Also:



309
310
311
312
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 309

def create_member(params = {}, options = {})
  req = build_request(:create_member, params)
  req.send_request(options)
end

#create_network(params = {}) ⇒ Types::CreateNetworkOutput

Creates a new blockchain network using Amazon Managed Blockchain.

Examples:

Request syntax with placeholder values


resp = client.create_network({
  client_request_token: "ClientRequestTokenString", # required
  name: "NameString", # required
  description: "DescriptionString",
  framework: "HYPERLEDGER_FABRIC", # required, accepts HYPERLEDGER_FABRIC
  framework_version: "FrameworkVersionString", # required
  framework_configuration: {
    fabric: {
      edition: "STARTER", # required, accepts STARTER, STANDARD
    },
  },
  voting_policy: { # required
    approval_threshold_policy: {
      threshold_percentage: 1,
      proposal_duration_in_hours: 1,
      threshold_comparator: "GREATER_THAN", # accepts GREATER_THAN, GREATER_THAN_OR_EQUAL_TO
    },
  },
  member_configuration: { # required
    name: "NetworkMemberNameString", # required
    description: "DescriptionString",
    framework_configuration: { # required
      fabric: {
        admin_username: "UsernameString", # required
        admin_password: "PasswordString", # required
      },
    },
  },
})

Response structure


resp.network_id #=> String
resp.member_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_request_token (required, String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String)

    The name of the network.

  • :description (String)

    An optional description for the network.

  • :framework (required, String)

    The blockchain framework that the network uses.

  • :framework_version (required, String)

    The version of the blockchain framework that the network uses.

  • :framework_configuration (Types::NetworkFrameworkConfiguration)

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

  • :voting_policy (required, Types::VotingPolicy)

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

  • :member_configuration (required, Types::MemberConfiguration)

    Configuration properties for the first member within the network.

Returns:

See Also:



395
396
397
398
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 395

def create_network(params = {}, options = {})
  req = build_request(:create_network, params)
  req.send_request(options)
end

#create_node(params = {}) ⇒ Types::CreateNodeOutput

Creates a peer node in a member.

Examples:

Request syntax with placeholder values


resp = client.create_node({
  client_request_token: "ClientRequestTokenString", # required
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
  node_configuration: { # required
    instance_type: "InstanceTypeString", # required
    availability_zone: "AvailabilityZoneString", # required
  },
})

Response structure


resp.node_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_request_token (required, String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :network_id (required, String)

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

  • :member_id (required, String)

    The unique identifier of the member that owns this node.

  • :node_configuration (required, Types::NodeConfiguration)

    The properties of a node configuration.

Returns:

See Also:



445
446
447
448
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 445

def create_node(params = {}, options = {})
  req = build_request(:create_node, params)
  req.send_request(options)
end

#create_proposal(params = {}) ⇒ Types::CreateProposalOutput

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.

Examples:

Request syntax with placeholder values


resp = client.create_proposal({
  client_request_token: "ClientRequestTokenString", # required
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
  actions: { # required
    invitations: [
      {
        principal: "PrincipalString", # required
      },
    ],
    removals: [
      {
        member_id: "ResourceIdString", # required
      },
    ],
  },
  description: "DescriptionString",
})

Response structure


resp.proposal_id #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :client_request_token (required, String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :network_id (required, String)

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

  • :member_id (required, String)

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

  • :actions (required, Types::ProposalActions)

    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.

  • :description (String)

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

Returns:

See Also:



515
516
517
518
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 515

def create_proposal(params = {}, options = {})
  req = build_request(:create_proposal, params)
  req.send_request(options)
end

#delete_member(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_member({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

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

  • :member_id (required, String)

    The unique identifier of the member to remove.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



548
549
550
551
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 548

def delete_member(params = {}, options = {})
  req = build_request(:delete_member, params)
  req.send_request(options)
end

#delete_node(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_node({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
  node_id: "ResourceIdString", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

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

  • :member_id (required, String)

    The unique identifier of the member that owns this node.

  • :node_id (required, String)

    The unique identifier of the node.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



579
580
581
582
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 579

def delete_node(params = {}, options = {})
  req = build_request(:delete_node, params)
  req.send_request(options)
end

#get_member(params = {}) ⇒ Types::GetMemberOutput

Returns detailed information about a member.

Examples:

Request syntax with placeholder values


resp = client.get_member({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
})

Response structure


resp.member.network_id #=> String
resp.member.id #=> String
resp.member.name #=> String
resp.member.description #=> String
resp.member.framework_attributes.fabric.admin_username #=> String
resp.member.framework_attributes.fabric.ca_endpoint #=> String
resp.member.status #=> String, one of "CREATING", "AVAILABLE", "CREATE_FAILED", "DELETING", "DELETED"
resp.member.creation_date #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

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

  • :member_id (required, String)

    The unique identifier of the member.

Returns:

See Also:



618
619
620
621
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 618

def get_member(params = {}, options = {})
  req = build_request(:get_member, params)
  req.send_request(options)
end

#get_network(params = {}) ⇒ Types::GetNetworkOutput

Returns detailed information about a network.

Examples:

Request syntax with placeholder values


resp = client.get_network({
  network_id: "ResourceIdString", # required
})

Response structure


resp.network.id #=> String
resp.network.name #=> String
resp.network.description #=> String
resp.network.framework #=> String, one of "HYPERLEDGER_FABRIC"
resp.network.framework_version #=> String
resp.network.framework_attributes.fabric.ordering_service_endpoint #=> String
resp.network.framework_attributes.fabric.edition #=> String, one of "STARTER", "STANDARD"
resp.network.vpc_endpoint_service_name #=> String
resp.network.voting_policy.approval_threshold_policy.threshold_percentage #=> Integer
resp.network.voting_policy.approval_threshold_policy.proposal_duration_in_hours #=> Integer
resp.network.voting_policy.approval_threshold_policy.threshold_comparator #=> String, one of "GREATER_THAN", "GREATER_THAN_OR_EQUAL_TO"
resp.network.status #=> String, one of "CREATING", "AVAILABLE", "CREATE_FAILED", "DELETING", "DELETED"
resp.network.creation_date #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

    The unique identifier of the network to get information about.

Returns:

See Also:



658
659
660
661
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 658

def get_network(params = {}, options = {})
  req = build_request(:get_network, params)
  req.send_request(options)
end

#get_node(params = {}) ⇒ Types::GetNodeOutput

Returns detailed information about a peer node.

Examples:

Request syntax with placeholder values


resp = client.get_node({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
  node_id: "ResourceIdString", # required
})

Response structure


resp.node.network_id #=> String
resp.node.member_id #=> String
resp.node.id #=> String
resp.node.instance_type #=> String
resp.node.availability_zone #=> String
resp.node.framework_attributes.fabric.peer_endpoint #=> String
resp.node.framework_attributes.fabric.peer_event_endpoint #=> String
resp.node.status #=> String, one of "CREATING", "AVAILABLE", "CREATE_FAILED", "DELETING", "DELETED", "FAILED"
resp.node.creation_date #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

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

  • :member_id (required, String)

    The unique identifier of the member that owns the node.

  • :node_id (required, String)

    The unique identifier of the node.

Returns:

See Also:



702
703
704
705
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 702

def get_node(params = {}, options = {})
  req = build_request(:get_node, params)
  req.send_request(options)
end

#get_proposal(params = {}) ⇒ Types::GetProposalOutput

Returns detailed information about a proposal.

Examples:

Request syntax with placeholder values


resp = client.get_proposal({
  network_id: "ResourceIdString", # required
  proposal_id: "ResourceIdString", # required
})

Response structure


resp.proposal.proposal_id #=> String
resp.proposal.network_id #=> String
resp.proposal.description #=> String
resp.proposal.actions.invitations #=> Array
resp.proposal.actions.invitations[0].principal #=> String
resp.proposal.actions.removals #=> Array
resp.proposal.actions.removals[0].member_id #=> String
resp.proposal.proposed_by_member_id #=> String
resp.proposal.proposed_by_member_name #=> String
resp.proposal.status #=> String, one of "IN_PROGRESS", "APPROVED", "REJECTED", "EXPIRED", "ACTION_FAILED"
resp.proposal.creation_date #=> Time
resp.proposal.expiration_date #=> Time
resp.proposal.yes_vote_count #=> Integer
resp.proposal.no_vote_count #=> Integer
resp.proposal.outstanding_vote_count #=> Integer

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

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

  • :proposal_id (required, String)

    The unique identifier of the proposal.

Returns:

See Also:



748
749
750
751
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 748

def get_proposal(params = {}, options = {})
  req = build_request(:get_proposal, params)
  req.send_request(options)
end

#list_invitations(params = {}) ⇒ Types::ListInvitationsOutput

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

Examples:

Request syntax with placeholder values


resp = client.list_invitations({
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.invitations #=> Array
resp.invitations[0].invitation_id #=> String
resp.invitations[0].creation_date #=> Time
resp.invitations[0].expiration_date #=> Time
resp.invitations[0].status #=> String, one of "PENDING", "ACCEPTED", "ACCEPTING", "REJECTED", "EXPIRED"
resp.invitations[0].network_summary.id #=> String
resp.invitations[0].network_summary.name #=> String
resp.invitations[0].network_summary.description #=> String
resp.invitations[0].network_summary.framework #=> String, one of "HYPERLEDGER_FABRIC"
resp.invitations[0].network_summary.framework_version #=> String
resp.invitations[0].network_summary.status #=> String, one of "CREATING", "AVAILABLE", "CREATE_FAILED", "DELETING", "DELETED"
resp.invitations[0].network_summary.creation_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :max_results (Integer)

    The maximum number of invitations to return.

  • :next_token (String)

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

Returns:

See Also:



794
795
796
797
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 794

def list_invitations(params = {}, options = {})
  req = build_request(:list_invitations, params)
  req.send_request(options)
end

#list_members(params = {}) ⇒ Types::ListMembersOutput

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

Examples:

Request syntax with placeholder values


resp = client.list_members({
  network_id: "ResourceIdString", # required
  name: "String",
  status: "CREATING", # accepts CREATING, AVAILABLE, CREATE_FAILED, DELETING, DELETED
  is_owned: false,
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.members #=> Array
resp.members[0].id #=> String
resp.members[0].name #=> String
resp.members[0].description #=> String
resp.members[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATE_FAILED", "DELETING", "DELETED"
resp.members[0].creation_date #=> Time
resp.members[0].is_owned #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

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

  • :name (String)

    The optional name of the member to list.

  • :status (String)

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

  • :is_owned (Boolean)

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

  • :max_results (Integer)

    The maximum number of members to return in the request.

  • :next_token (String)

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

Returns:

See Also:



855
856
857
858
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 855

def list_members(params = {}, options = {})
  req = build_request(:list_members, params)
  req.send_request(options)
end

#list_networks(params = {}) ⇒ Types::ListNetworksOutput

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

Examples:

Request syntax with placeholder values


resp = client.list_networks({
  name: "String",
  framework: "HYPERLEDGER_FABRIC", # accepts HYPERLEDGER_FABRIC
  status: "CREATING", # accepts CREATING, AVAILABLE, CREATE_FAILED, DELETING, DELETED
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.networks #=> Array
resp.networks[0].id #=> String
resp.networks[0].name #=> String
resp.networks[0].description #=> String
resp.networks[0].framework #=> String, one of "HYPERLEDGER_FABRIC"
resp.networks[0].framework_version #=> String
resp.networks[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATE_FAILED", "DELETING", "DELETED"
resp.networks[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

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

  • :max_results (Integer)

    The maximum number of networks to list.

  • :next_token (String)

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

Returns:

See Also:



912
913
914
915
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 912

def list_networks(params = {}, options = {})
  req = build_request(:list_networks, params)
  req.send_request(options)
end

#list_nodes(params = {}) ⇒ Types::ListNodesOutput

Returns information about the nodes within a network.

Examples:

Request syntax with placeholder values


resp = client.list_nodes({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
  status: "CREATING", # accepts CREATING, AVAILABLE, CREATE_FAILED, DELETING, DELETED, FAILED
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.nodes #=> Array
resp.nodes[0].id #=> String
resp.nodes[0].status #=> String, one of "CREATING", "AVAILABLE", "CREATE_FAILED", "DELETING", "DELETED", "FAILED"
resp.nodes[0].creation_date #=> Time
resp.nodes[0].availability_zone #=> String
resp.nodes[0].instance_type #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

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

  • :member_id (required, String)

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

  • :status (String)

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

  • :max_results (Integer)

    The maximum number of nodes to list.

  • :next_token (String)

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

Returns:

See Also:



965
966
967
968
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 965

def list_nodes(params = {}, options = {})
  req = build_request(:list_nodes, params)
  req.send_request(options)
end

#list_proposal_votes(params = {}) ⇒ Types::ListProposalVotesOutput

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

Examples:

Request syntax with placeholder values


resp = client.list_proposal_votes({
  network_id: "ResourceIdString", # required
  proposal_id: "ResourceIdString", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.proposal_votes #=> Array
resp.proposal_votes[0].vote #=> String, one of "YES", "NO"
resp.proposal_votes[0].member_name #=> String
resp.proposal_votes[0].member_id #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

    The unique identifier of the network.

  • :proposal_id (required, String)

    The unique identifier of the proposal.

  • :max_results (Integer)

    The maximum number of votes to return.

  • :next_token (String)

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

Returns:

See Also:



1013
1014
1015
1016
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1013

def list_proposal_votes(params = {}, options = {})
  req = build_request(:list_proposal_votes, params)
  req.send_request(options)
end

#list_proposals(params = {}) ⇒ Types::ListProposalsOutput

Returns a listing of proposals for the network.

Examples:

Request syntax with placeholder values


resp = client.list_proposals({
  network_id: "ResourceIdString", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.proposals #=> Array
resp.proposals[0].proposal_id #=> String
resp.proposals[0].description #=> String
resp.proposals[0].proposed_by_member_id #=> String
resp.proposals[0].proposed_by_member_name #=> String
resp.proposals[0].status #=> String, one of "IN_PROGRESS", "APPROVED", "REJECTED", "EXPIRED", "ACTION_FAILED"
resp.proposals[0].creation_date #=> Time
resp.proposals[0].expiration_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

    The unique identifier of the network.

  • :max_results (Integer)

    The maximum number of proposals to return.

  • :next_token (String)

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

Returns:

See Also:



1059
1060
1061
1062
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1059

def list_proposals(params = {}, options = {})
  req = build_request(:list_proposals, params)
  req.send_request(options)
end

#reject_invitation(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.reject_invitation({
  invitation_id: "ResourceIdString", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :invitation_id (required, String)

    The unique identifier of the invitation to reject.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1083
1084
1085
1086
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1083

def reject_invitation(params = {}, options = {})
  req = build_request(:reject_invitation, params)
  req.send_request(options)
end

#vote_on_proposal(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.vote_on_proposal({
  network_id: "ResourceIdString", # required
  proposal_id: "ResourceIdString", # required
  voter_member_id: "ResourceIdString", # required
  vote: "YES", # required, accepts YES, NO
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :network_id (required, String)

    The unique identifier of the network.

  • :proposal_id (required, String)

    The unique identifier of the proposal.

  • :voter_member_id (required, String)

    The unique identifier of the member casting the vote.

  • :vote (required, String)

    The value of the vote.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1119
1120
1121
1122
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1119

def vote_on_proposal(params = {}, options = {})
  req = build_request(:vote_on_proposal, params)
  req.send_request(options)
end