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

Class: Aws::ManagedBlockchain::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

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

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

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

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::ManagedBlockchain::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::ManagedBlockchain::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean)

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

  • :convert_params (Boolean) — default: true

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials)

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean)

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String)

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer)

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer)

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer)

    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. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean)

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter)

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String)

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String)

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :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. See Plugins::RetryErrors for more details.

  • :secret_access_key (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String)

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :ssl_ca_bundle (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String)

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :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. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_member(options = {}) ⇒ 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

Options Hash (options):

  • :client_request_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. 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.

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

#create_network(options = {}) ⇒ 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

Options Hash (options):

  • :client_request_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. 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.

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

#create_node(options = {}) ⇒ 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

Options Hash (options):

  • :client_request_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. 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.

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

#create_proposal(options = {}) ⇒ 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

Options Hash (options):

  • :client_request_token (required, String)

    This parameter will be auto-filled on your behalf with a random UUIDv4 when no value is provided. 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.

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

#delete_member(options = {}) ⇒ 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
})

Options Hash (options):

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

#delete_node(options = {}) ⇒ 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
})

Options Hash (options):

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

#get_member(options = {}) ⇒ 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

Options Hash (options):

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

#get_network(options = {}) ⇒ 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

Options Hash (options):

  • :network_id (required, String)

    The unique identifier of the network to get information about.

Returns:

See Also:

#get_node(options = {}) ⇒ 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

Options Hash (options):

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

#get_proposal(options = {}) ⇒ 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

Options Hash (options):

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

#list_invitations(options = {}) ⇒ 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

Options Hash (options):

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

#list_members(options = {}) ⇒ 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 #=> true/false
resp.next_token #=> String

Options Hash (options):

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

#list_networks(options = {}) ⇒ 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

Options Hash (options):

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

#list_nodes(options = {}) ⇒ 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

Options Hash (options):

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

#list_proposal_votes(options = {}) ⇒ 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

Options Hash (options):

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

#list_proposals(options = {}) ⇒ 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

Options Hash (options):

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

#reject_invitation(options = {}) ⇒ 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
})

Options Hash (options):

  • :invitation_id (required, String)

    The unique identifier of the invitation to reject.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#vote_on_proposal(options = {}) ⇒ 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
})

Options Hash (options):

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

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol)

    The name of the waiter. See #waiter_names for a full list of supported waiters.

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

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError)

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError)

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.