AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ManagedBlockchain::Types::ListMembersInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb

Overview

Note:

When making an API call, you may pass ListMembersInput data as a hash:

{
  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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#is_ownedBoolean

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.

Returns:

  • (Boolean)


946
947
948
949
950
951
952
953
954
955
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 946

class ListMembersInput < Struct.new(
  :network_id,
  :name,
  :status,
  :is_owned,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of members to return in the request.

Returns:

  • (Integer)


946
947
948
949
950
951
952
953
954
955
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 946

class ListMembersInput < Struct.new(
  :network_id,
  :name,
  :status,
  :is_owned,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The optional name of the member to list.

Returns:

  • (String)


946
947
948
949
950
951
952
953
954
955
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 946

class ListMembersInput < Struct.new(
  :network_id,
  :name,
  :status,
  :is_owned,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#network_idString

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

Returns:

  • (String)


946
947
948
949
950
951
952
953
954
955
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 946

class ListMembersInput < Struct.new(
  :network_id,
  :name,
  :status,
  :is_owned,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


946
947
948
949
950
951
952
953
954
955
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 946

class ListMembersInput < Struct.new(
  :network_id,
  :name,
  :status,
  :is_owned,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


946
947
948
949
950
951
952
953
954
955
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 946

class ListMembersInput < Struct.new(
  :network_id,
  :name,
  :status,
  :is_owned,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end