Class: Aws::ManagedBlockchain::Client

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

Overview

An API client for ManagedBlockchain. To construct a client, you need to configure a :region and :credentials.

client = Aws::ManagedBlockchain::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

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):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

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

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

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :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 searched 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)
  • :account_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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::ManagedBlockchain::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ManagedBlockchain::EndpointParameters.

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

  • :http_proxy (URI::HTTP, String) —

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



471
472
473
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#create_accessor(params = {}) ⇒ Types::CreateAccessorOutput

Creates a new accessor for use with Amazon Managed Blockchain service that supports token based access. The accessor contains information required for token based access.

Examples:

Request syntax with placeholder values


resp = client.create_accessor({
  client_request_token: "ClientRequestTokenString", # required
  accessor_type: "BILLING_TOKEN", # required, accepts BILLING_TOKEN
  tags: {
    "TagKey" => "TagValue",
  },
  network_type: "ETHEREUM_GOERLI", # accepts ETHEREUM_GOERLI, ETHEREUM_MAINNET, ETHEREUM_MAINNET_AND_GOERLI, POLYGON_MAINNET, POLYGON_MUMBAI
})

Response structure


resp.accessor_id #=> String
resp.billing_token #=> String
resp.network_type #=> String, one of "ETHEREUM_GOERLI", "ETHEREUM_MAINNET", "ETHEREUM_MAINNET_AND_GOERLI", "POLYGON_MAINNET", "POLYGON_MUMBAI"

Parameters:

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

    ({})

Options Hash (params):

  • :client_request_token (required, String) —

    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.

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

  • :accessor_type (required, String) —

    The type of accessor.

    Currently, accessor type is restricted to BILLING_TOKEN.

  • :tags (Hash<String,String>) —

    Tags to assign to the Accessor.

    Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

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

  • :network_type (String) —

    The blockchain network that the Accessor token is created for.

    * Use the actual networkType value for the blockchain network that you are creating the Accessor token for.

    • With the shut down of the Ethereum Goerli and Polygon Mumbai Testnet networks the following networkType values are no longer available for selection and use.

      • ETHEREUM_MAINNET_AND_GOERLI

      • ETHEREUM_GOERLI

      • POLYGON_MUMBAI However, your existing Accessor tokens with these networkType values will remain unchanged.

Returns:

See Also:



562
563
564
565
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 562

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

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

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

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
      },
    },
    log_publishing_configuration: {
      fabric: {
        ca_logs: {
          cloudwatch: {
            enabled: false,
          },
        },
      },
    },
    tags: {
      "TagKey" => "TagValue",
    },
    kms_key_arn: "ArnString",
  },
})

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 Amazon Web Services SDK or the 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:



634
635
636
637
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 634

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.

Applies only to Hyperledger Fabric.

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, ETHEREUM
  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
      },
    },
    log_publishing_configuration: {
      fabric: {
        ca_logs: {
          cloudwatch: {
            enabled: false,
          },
        },
      },
    },
    tags: {
      "TagKey" => "TagValue",
    },
    kms_key_arn: "ArnString",
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :client_request_token (required, String) —

    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.

    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.

  • :tags (Hash<String,String>) —

    Tags to assign to the network.

    Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

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

Returns:

See Also:



755
756
757
758
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 755

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

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

Creates a node on the specified blockchain network.

Applies to Hyperledger Fabric and Ethereum.

Examples:

Request syntax with placeholder values


resp = client.create_node({
  client_request_token: "ClientRequestTokenString", # required
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString",
  node_configuration: { # required
    instance_type: "InstanceTypeString", # required
    availability_zone: "AvailabilityZoneString",
    log_publishing_configuration: {
      fabric: {
        chaincode_logs: {
          cloudwatch: {
            enabled: false,
          },
        },
        peer_logs: {
          cloudwatch: {
            enabled: false,
          },
        },
      },
    },
    state_db: "LevelDB", # accepts LevelDB, CouchDB
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

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 Amazon Web Services SDK or the 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 the node.

    Ethereum public networks have the following NetworkIds:

    • n-ethereum-mainnet

    ^

  • :member_id (String) —

    The unique identifier of the member that owns this node.

    Applies only to Hyperledger Fabric.

  • :node_configuration (required, Types::NodeConfiguration) —

    The properties of a node configuration.

  • :tags (Hash<String,String>) —

    Tags to assign to the node.

    Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

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

Returns:

See Also:



850
851
852
853
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 850

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.

Applies only to Hyperledger Fabric.

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",
  tags: {
    "TagKey" => "TagValue",
  },
})

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 Amazon Web Services SDK or the 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 Amazon Web Services 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."

  • :tags (Hash<String,String>) —

    Tags to assign to the proposal.

    Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per resource.

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

Returns:

See Also:



943
944
945
946
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 943

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

#delete_accessor(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.delete_accessor({
  accessor_id: "ResourceIdString", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :accessor_id (required, String) —

    The unique identifier of the accessor.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



973
974
975
976
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 973

def delete_accessor(params = {}, options = {})
  req = build_request(:delete_accessor, 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 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.

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:



1008
1009
1010
1011
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1008

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

#delete_node(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_node({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString",
  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 is on.

    Ethereum public networks have the following NetworkIds:

    • n-ethereum-mainnet

    ^

  • :member_id (String) —

    The unique identifier of the member that owns this node.

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

  • :node_id (required, String) —

    The unique identifier of the node.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1050
1051
1052
1053
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1050

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

#get_accessor(params = {}) ⇒ Types::GetAccessorOutput

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.

Examples:

Request syntax with placeholder values


resp = client.get_accessor({
  accessor_id: "ResourceIdString", # required
})

Response structure


resp.accessor.id #=> String
resp.accessor.type #=> String, one of "BILLING_TOKEN"
resp.accessor.billing_token #=> String
resp.accessor.status #=> String, one of "AVAILABLE", "PENDING_DELETION", "DELETED"
resp.accessor.creation_date #=> Time
resp.accessor.arn #=> String
resp.accessor.tags #=> Hash
resp.accessor.tags["TagKey"] #=> String
resp.accessor.network_type #=> String, one of "ETHEREUM_GOERLI", "ETHEREUM_MAINNET", "ETHEREUM_MAINNET_AND_GOERLI", "POLYGON_MAINNET", "POLYGON_MUMBAI"

Parameters:

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

    ({})

Options Hash (params):

  • :accessor_id (required, String) —

    The unique identifier of the accessor.

Returns:

See Also:



1088
1089
1090
1091
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1088

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

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

Returns detailed information about a member.

Applies only to Hyperledger Fabric.

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.log_publishing_configuration.fabric.ca_logs.cloudwatch.enabled #=> Boolean
resp.member.status #=> String, one of "CREATING", "AVAILABLE", "CREATE_FAILED", "UPDATING", "DELETING", "DELETED", "INACCESSIBLE_ENCRYPTION_KEY"
resp.member.creation_date #=> Time
resp.member.tags #=> Hash
resp.member.tags["TagKey"] #=> String
resp.member.arn #=> String
resp.member.kms_key_arn #=> String

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:



1134
1135
1136
1137
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1134

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.

Applies to Hyperledger Fabric and Ethereum.

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", "ETHEREUM"
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.framework_attributes.ethereum.chain_id #=> String
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
resp.network.tags #=> Hash
resp.network.tags["TagKey"] #=> String
resp.network.arn #=> String

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:



1180
1181
1182
1183
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1180

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

Applies to Hyperledger Fabric and Ethereum.

Examples:

Request syntax with placeholder values


resp = client.get_node({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString",
  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.framework_attributes.ethereum.http_endpoint #=> String
resp.node.framework_attributes.ethereum.web_socket_endpoint #=> String
resp.node.log_publishing_configuration.fabric.chaincode_logs.cloudwatch.enabled #=> Boolean
resp.node.log_publishing_configuration.fabric.peer_logs.cloudwatch.enabled #=> Boolean
resp.node.state_db #=> String, one of "LevelDB", "CouchDB"
resp.node.status #=> String, one of "CREATING", "AVAILABLE", "UNHEALTHY", "CREATE_FAILED", "UPDATING", "DELETING", "DELETED", "FAILED", "INACCESSIBLE_ENCRYPTION_KEY"
resp.node.creation_date #=> Time
resp.node.tags #=> Hash
resp.node.tags["TagKey"] #=> String
resp.node.arn #=> String
resp.node.kms_key_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :network_id (required, String) —

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

  • :member_id (String) —

    The unique identifier of the member that owns the node.

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

  • :node_id (required, String) —

    The unique identifier of the node.

Returns:

See Also:



1238
1239
1240
1241
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1238

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.

Applies only to Hyperledger Fabric.

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
resp.proposal.tags #=> Hash
resp.proposal.tags["TagKey"] #=> String
resp.proposal.arn #=> String

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:



1289
1290
1291
1292
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1289

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

#list_accessors(params = {}) ⇒ Types::ListAccessorsOutput

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_accessors({
  max_results: 1,
  next_token: "PaginationToken",
  network_type: "ETHEREUM_GOERLI", # accepts ETHEREUM_GOERLI, ETHEREUM_MAINNET, ETHEREUM_MAINNET_AND_GOERLI, POLYGON_MAINNET, POLYGON_MUMBAI
})

Response structure


resp.accessors #=> Array
resp.accessors[0].id #=> String
resp.accessors[0].type #=> String, one of "BILLING_TOKEN"
resp.accessors[0].status #=> String, one of "AVAILABLE", "PENDING_DELETION", "DELETED"
resp.accessors[0].creation_date #=> Time
resp.accessors[0].arn #=> String
resp.accessors[0].network_type #=> String, one of "ETHEREUM_GOERLI", "ETHEREUM_MAINNET", "ETHEREUM_MAINNET_AND_GOERLI", "POLYGON_MAINNET", "POLYGON_MUMBAI"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of accessors to list.

  • :next_token (String) —

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

  • :network_type (String) —

    The blockchain network that the Accessor token is created for.

    Use the value ETHEREUM_MAINNET_AND_GOERLI for all existing Accessors tokens that were created before the networkType property was introduced.

Returns:

See Also:



1344
1345
1346
1347
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1344

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

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

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

Applies only to Hyperledger Fabric.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "ETHEREUM"
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.invitations[0].network_summary.arn #=> String
resp.invitations[0].arn #=> String
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:



1397
1398
1399
1400
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1397

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

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

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

Applies only to Hyperledger Fabric.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_members({
  network_id: "ResourceIdString", # required
  name: "String",
  status: "CREATING", # accepts CREATING, AVAILABLE, CREATE_FAILED, UPDATING, DELETING, DELETED, INACCESSIBLE_ENCRYPTION_KEY
  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", "UPDATING", "DELETING", "DELETED", "INACCESSIBLE_ENCRYPTION_KEY"
resp.members[0].creation_date #=> Time
resp.members[0].is_owned #=> Boolean
resp.members[0].arn #=> 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 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 Amazon Web Services account owns (true) or that other Amazon Web Services accountsn 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:



1464
1465
1466
1467
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1464

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 Amazon Web Services account participates.

Applies to Hyperledger Fabric and Ethereum.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_networks({
  name: "String",
  framework: "HYPERLEDGER_FABRIC", # accepts HYPERLEDGER_FABRIC, ETHEREUM
  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", "ETHEREUM"
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.networks[0].arn #=> String
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.

    Applies only to Hyperledger Fabric.

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



1528
1529
1530
1531
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1528

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.

Applies to Hyperledger Fabric and Ethereum.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_nodes({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString",
  status: "CREATING", # accepts CREATING, AVAILABLE, UNHEALTHY, CREATE_FAILED, UPDATING, DELETING, DELETED, FAILED, INACCESSIBLE_ENCRYPTION_KEY
  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", "UNHEALTHY", "CREATE_FAILED", "UPDATING", "DELETING", "DELETED", "FAILED", "INACCESSIBLE_ENCRYPTION_KEY"
resp.nodes[0].creation_date #=> Time
resp.nodes[0].availability_zone #=> String
resp.nodes[0].instance_type #=> String
resp.nodes[0].arn #=> 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 (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.

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



1589
1590
1591
1592
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1589

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

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

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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:



1641
1642
1643
1644
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1641

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 list of proposals for the network.

Applies only to Hyperledger Fabric.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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.proposals[0].arn #=> String
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:



1692
1693
1694
1695
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1692

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

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.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "ArnString", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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.

Returns:

See Also:



1738
1739
1740
1741
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1738

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, 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 Amazon Web Services account that has received an invitation to create a member and join a network.

Applies only to Hyperledger Fabric.

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:



1764
1765
1766
1767
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1764

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

#tag_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ArnString", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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 (required, Hash<String,String>) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1819
1820
1821
1822
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1819

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

#untag_resource(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "ArnString", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    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.

  • :tag_keys (required, Array<String>) —

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1862
1863
1864
1865
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1862

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

#update_member(params = {}) ⇒ Struct

Updates a member configuration with new parameters.

Applies only to Hyperledger Fabric.

Examples:

Request syntax with placeholder values


resp = client.update_member({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
  log_publishing_configuration: {
    fabric: {
      ca_logs: {
        cloudwatch: {
          enabled: false,
        },
      },
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :network_id (required, String) —

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

  • :member_id (required, String) —

    The unique identifier of the member.

  • :log_publishing_configuration (Types::MemberLogPublishingConfiguration) —

    Configuration properties for publishing to Amazon CloudWatch Logs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1903
1904
1905
1906
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1903

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

#update_node(params = {}) ⇒ Struct

Updates a node configuration with new parameters.

Applies only to Hyperledger Fabric.

Examples:

Request syntax with placeholder values


resp = client.update_node({
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString",
  node_id: "ResourceIdString", # required
  log_publishing_configuration: {
    fabric: {
      chaincode_logs: {
        cloudwatch: {
          enabled: false,
        },
      },
      peer_logs: {
        cloudwatch: {
          enabled: false,
        },
      },
    },
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :network_id (required, String) —

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

  • :member_id (String) —

    The unique identifier of the member that owns the node.

    Applies only to Hyperledger Fabric.

  • :node_id (required, String) —

    The unique identifier of the node.

  • :log_publishing_configuration (Types::NodeLogPublishingConfiguration) —

    Configuration properties for publishing to Amazon CloudWatch Logs.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1954
1955
1956
1957
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1954

def update_node(params = {}, options = {})
  req = build_request(:update_node, 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 Amazon Web Services account as the principal that calls the action.

Applies only to Hyperledger Fabric.

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:



1992
1993
1994
1995
 
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/client.rb', line 1992

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