Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ManagedBlockChain.ListMembers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Applies only to Hyperledger Fabric.

Synopsis

data ListMembers = ListMembers' {
- isOwned :: Maybe Bool
- maxResults :: Maybe Natural
- name :: Maybe Text
- nextToken :: Maybe Text
- status :: Maybe MemberStatus
- networkId :: Text
}
newListMembers :: Text -> ListMembers
listMembers_isOwned :: Lens' ListMembers (Maybe Bool)
listMembers_maxResults :: Lens' ListMembers (Maybe Natural)
listMembers_name :: Lens' ListMembers (Maybe Text)
listMembers_nextToken :: Lens' ListMembers (Maybe Text)
listMembers_status :: Lens' ListMembers (Maybe MemberStatus)
listMembers_networkId :: Lens' ListMembers Text
data ListMembersResponse = ListMembersResponse' {
- members :: Maybe [MemberSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListMembersResponse :: Int -> ListMembersResponse
listMembersResponse_members :: Lens' ListMembersResponse (Maybe [MemberSummary])
listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text)
listMembersResponse_httpStatus :: Lens' ListMembersResponse Int

Creating a Request

data ListMembers Source #

See: newListMembers smart constructor.

Constructors

ListMembers'

Fields

isOwned :: Maybe Bool
An optional Boolean value. If provided, the request is limited either to members that the current Amazon Web Services account owns (true) or that other Amazon Web Services accountsn own (false). If omitted, all members are listed.
maxResults :: Maybe Natural
The maximum number of members to return in the request.
name :: Maybe Text
The optional name of the member to list.
nextToken :: Maybe Text
The pagination token that indicates the next set of results to retrieve.
status :: Maybe MemberStatus
An optional status specifier. If provided, only members currently in this status are listed.
networkId :: Text
The unique identifier of the network for which to list members.

Instances

Instances details

ToHeaders ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods toHeaders :: ListMembers -> [Header] #
ToPath ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods toPath :: ListMembers -> ByteString #
ToQuery ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods toQuery :: ListMembers -> QueryString #
AWSRequest ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Associated Types type AWSResponse ListMembers # Methods request :: (Service -> Service) -> ListMembers -> Request ListMembers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListMembers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMembers))) #
Generic ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Associated Types type Rep ListMembers :: Type -> Type # Methods from :: ListMembers -> Rep ListMembers x # to :: Rep ListMembers x -> ListMembers #
Read ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods readsPrec :: Int -> ReadS ListMembers # readList :: ReadS [ListMembers] # readPrec :: ReadPrec ListMembers # readListPrec :: ReadPrec [ListMembers] #
Show ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods showsPrec :: Int -> ListMembers -> ShowS # show :: ListMembers -> String # showList :: [ListMembers] -> ShowS #
NFData ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods rnf :: ListMembers -> () #
Eq ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods (==) :: ListMembers -> ListMembers -> Bool # (/=) :: ListMembers -> ListMembers -> Bool #
Hashable ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods hashWithSalt :: Int -> ListMembers -> Int # hash :: ListMembers -> Int #
type AWSResponse ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers type AWSResponse ListMembers = ListMembersResponse
type Rep ListMembers Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers type Rep ListMembers = D1 ('MetaData "ListMembers" "Amazonka.ManagedBlockChain.ListMembers" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "ListMembers'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "isOwned") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MemberStatus)) :*: S1 ('MetaSel ('Just "networkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListMembers Source #

Arguments

:: Text	`ListMembers`
-> ListMembers

Create a value of ListMembers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListMembers, listMembers_isOwned - 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.

$sel:maxResults:ListMembers', listMembers_maxResults - The maximum number of members to return in the request.

ListMembers, listMembers_name - The optional name of the member to list.

ListMembers, listMembers_nextToken - The pagination token that indicates the next set of results to retrieve.

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

ListMembers, listMembers_networkId - The unique identifier of the network for which to list members.

Request Lenses

listMembers_isOwned :: Lens' ListMembers (Maybe Bool) Source #

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.

listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #

The maximum number of members to return in the request.

listMembers_name :: Lens' ListMembers (Maybe Text) Source #

The optional name of the member to list.

listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #

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

listMembers_status :: Lens' ListMembers (Maybe MemberStatus) Source #

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

listMembers_networkId :: Lens' ListMembers Text Source #

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

Destructuring the Response

data ListMembersResponse Source #

See: newListMembersResponse smart constructor.

Constructors

ListMembersResponse'
Fields members :: Maybe [MemberSummary] An array of `MemberSummary` objects. Each object contains details about a network member. nextToken :: Maybe Text The pagination token that indicates the next set of results to retrieve. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListMembersResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Associated Types type Rep ListMembersResponse :: Type -> Type # Methods from :: ListMembersResponse -> Rep ListMembersResponse x # to :: Rep ListMembersResponse x -> ListMembersResponse #
Read ListMembersResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods readsPrec :: Int -> ReadS ListMembersResponse # readList :: ReadS [ListMembersResponse] # readPrec :: ReadPrec ListMembersResponse # readListPrec :: ReadPrec [ListMembersResponse] #
Show ListMembersResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods showsPrec :: Int -> ListMembersResponse -> ShowS # show :: ListMembersResponse -> String # showList :: [ListMembersResponse] -> ShowS #
NFData ListMembersResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods rnf :: ListMembersResponse -> () #
Eq ListMembersResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers Methods (==) :: ListMembersResponse -> ListMembersResponse -> Bool # (/=) :: ListMembersResponse -> ListMembersResponse -> Bool #
type Rep ListMembersResponse Source #
Instance details Defined in Amazonka.ManagedBlockChain.ListMembers type Rep ListMembersResponse = D1 ('MetaData "ListMembersResponse" "Amazonka.ManagedBlockChain.ListMembers" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "ListMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "members") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MemberSummary])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListMembersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListMembersResponse'`
-> ListMembersResponse

Create a value of ListMembersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:members:ListMembersResponse', listMembersResponse_members - An array of MemberSummary objects. Each object contains details about a network member.

ListMembers, listMembersResponse_nextToken - The pagination token that indicates the next set of results to retrieve.

$sel:httpStatus:ListMembersResponse', listMembersResponse_httpStatus - The response's http status code.

Response Lenses

listMembersResponse_members :: Lens' ListMembersResponse (Maybe [MemberSummary]) Source #

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

listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #

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

listMembersResponse_httpStatus :: Lens' ListMembersResponse Int Source #

The response's http status code.