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.Inspector2.ListMembers

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List members associated with the Amazon Inspector delegated administrator for your organization.

This operation returns paginated results.

Synopsis

Creating a Request

data ListMembers Source #

See: newListMembers smart constructor.

Constructors

ListMembers'

Fields

maxResults :: Maybe Natural
The maximum number of results to return in the response.
nextToken :: Maybe Text
A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
onlyAssociated :: Maybe Bool
Specifies whether to list only currently associated members if True or to list all members within the organization if False.

Instances

Instances details

ToJSON ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods toJSON :: ListMembers -> Value # toEncoding :: ListMembers -> Encoding # toJSONList :: [ListMembers] -> Value # toEncodingList :: [ListMembers] -> Encoding #
ToHeaders ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods toHeaders :: ListMembers -> [Header] #
ToPath ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods toPath :: ListMembers -> ByteString #
ToQuery ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods toQuery :: ListMembers -> QueryString #
AWSPager ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods page :: ListMembers -> AWSResponse ListMembers -> Maybe ListMembers #
AWSRequest ListMembers Source #
Instance details Defined in Amazonka.Inspector2.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.Inspector2.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.Inspector2.ListMembers Methods readsPrec :: Int -> ReadS ListMembers # readList :: ReadS [ListMembers] # readPrec :: ReadPrec ListMembers # readListPrec :: ReadPrec [ListMembers] #
Show ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods showsPrec :: Int -> ListMembers -> ShowS # show :: ListMembers -> String # showList :: [ListMembers] -> ShowS #
NFData ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods rnf :: ListMembers -> () #
Eq ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods (==) :: ListMembers -> ListMembers -> Bool # (/=) :: ListMembers -> ListMembers -> Bool #
Hashable ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods hashWithSalt :: Int -> ListMembers -> Int # hash :: ListMembers -> Int #
type AWSResponse ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers type AWSResponse ListMembers = ListMembersResponse
type Rep ListMembers Source #
Instance details Defined in Amazonka.Inspector2.ListMembers type Rep ListMembers = D1 ('MetaData "ListMembers" "Amazonka.Inspector2.ListMembers" "amazonka-inspector2-2.0-EI0CfxGdACSBWwvVde8cFy" 'False) (C1 ('MetaCons "ListMembers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "onlyAssociated") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newListMembers :: ListMembers Source #

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:

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

ListMembers, listMembers_nextToken - A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

$sel:onlyAssociated:ListMembers', listMembers_onlyAssociated - Specifies whether to list only currently associated members if True or to list all members within the organization if False.

Request Lenses

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

The maximum number of results to return in the response.

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

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

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

Specifies whether to list only currently associated members if True or to list all members within the organization if False.

Destructuring the Response

data ListMembersResponse Source #

See: newListMembersResponse smart constructor.

Constructors

ListMembersResponse'
Fields members :: Maybe [Member] An object that contains details for each member account. nextToken :: Maybe Text The pagination parameter to be used on the next list operation to retrieve more items. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListMembersResponse Source #
Instance details Defined in Amazonka.Inspector2.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.Inspector2.ListMembers Methods readsPrec :: Int -> ReadS ListMembersResponse # readList :: ReadS [ListMembersResponse] # readPrec :: ReadPrec ListMembersResponse # readListPrec :: ReadPrec [ListMembersResponse] #
Show ListMembersResponse Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods showsPrec :: Int -> ListMembersResponse -> ShowS # show :: ListMembersResponse -> String # showList :: [ListMembersResponse] -> ShowS #
NFData ListMembersResponse Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods rnf :: ListMembersResponse -> () #
Eq ListMembersResponse Source #
Instance details Defined in Amazonka.Inspector2.ListMembers Methods (==) :: ListMembersResponse -> ListMembersResponse -> Bool # (/=) :: ListMembersResponse -> ListMembersResponse -> Bool #
type Rep ListMembersResponse Source #
Instance details Defined in Amazonka.Inspector2.ListMembers type Rep ListMembersResponse = D1 ('MetaData "ListMembersResponse" "Amazonka.Inspector2.ListMembers" "amazonka-inspector2-2.0-EI0CfxGdACSBWwvVde8cFy" 'False) (C1 ('MetaCons "ListMembersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "members") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Member])) :: (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 object that contains details for each member account.

ListMembers, listMembersResponse_nextToken - The pagination parameter to be used on the next list operation to retrieve more items.

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

Response Lenses

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

An object that contains details for each member account.

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

The pagination parameter to be used on the next list operation to retrieve more items.

listMembersResponse_httpStatus :: Lens' ListMembersResponse Int Source #

The response's http status code.