amazonka-guardduty-1.6.1: Amazon GuardDuty SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.GuardDuty.ListMembers

Contents

Description

Lists details about all member accounts for the current GuardDuty master account.

This operation returns paginated results.

Synopsis

Creating a Request

listMembers Source #

Creates a value of ListMembers with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • lmOnlyAssociated - Specifies what member accounts the response is to include based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response will include member accounts whose relationship status with the master is set to Enabled, Disabled. If onlyAssociated is set to FALSE, the response will include all existing member accounts.
  • lmNextToken - You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMembers action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
  • lmMaxResults - You can use this parameter to indicate the maximum number of items you want in the response. The default value is 1. The maximum value is 50.
  • lmDetectorId - The unique ID of the detector of the GuardDuty account whose members you want to list.

data ListMembers Source #

See: listMembers smart constructor.

Instances
Eq ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Data ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListMembers -> c ListMembers #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListMembers #

toConstr :: ListMembers -> Constr #

dataTypeOf :: ListMembers -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListMembers) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListMembers) #

gmapT :: (forall b. Data b => b -> b) -> ListMembers -> ListMembers #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListMembers -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListMembers -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListMembers -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListMembers -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListMembers -> m ListMembers #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMembers -> m ListMembers #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMembers -> m ListMembers #

Read ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Show ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Generic ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Associated Types

type Rep ListMembers :: Type -> Type #

Hashable ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

AWSPager ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

AWSRequest ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Associated Types

type Rs ListMembers :: Type #

ToHeaders ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Methods

toHeaders :: ListMembers -> [Header] #

ToPath ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

ToQuery ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

NFData ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Methods

rnf :: ListMembers -> () #

type Rep ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

type Rep ListMembers = D1 (MetaData "ListMembers" "Network.AWS.GuardDuty.ListMembers" "amazonka-guardduty-1.6.1-K5KFXxug8mfBfLPNNuAp3C" False) (C1 (MetaCons "ListMembers'" PrefixI True) ((S1 (MetaSel (Just "_lmOnlyAssociated") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lmNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_lmMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_lmDetectorId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))
type Rs ListMembers Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Request Lenses

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

Specifies what member accounts the response is to include based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response will include member accounts whose relationship status with the master is set to Enabled, Disabled. If onlyAssociated is set to FALSE, the response will include all existing member accounts.

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

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMembers action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

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

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 1. The maximum value is 50.

lmDetectorId :: Lens' ListMembers Text Source #

The unique ID of the detector of the GuardDuty account whose members you want to list.

Destructuring the Response

listMembersResponse Source #

Creates a value of ListMembersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data ListMembersResponse Source #

See: listMembersResponse smart constructor.

Instances
Eq ListMembersResponse Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Data ListMembersResponse Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ListMembersResponse -> c ListMembersResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ListMembersResponse #

toConstr :: ListMembersResponse -> Constr #

dataTypeOf :: ListMembersResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ListMembersResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ListMembersResponse) #

gmapT :: (forall b. Data b => b -> b) -> ListMembersResponse -> ListMembersResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ListMembersResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ListMembersResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ListMembersResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ListMembersResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ListMembersResponse -> m ListMembersResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMembersResponse -> m ListMembersResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ListMembersResponse -> m ListMembersResponse #

Read ListMembersResponse Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Show ListMembersResponse Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Generic ListMembersResponse Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Associated Types

type Rep ListMembersResponse :: Type -> Type #

NFData ListMembersResponse Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

Methods

rnf :: ListMembersResponse -> () #

type Rep ListMembersResponse Source # 
Instance details

Defined in Network.AWS.GuardDuty.ListMembers

type Rep ListMembersResponse = D1 (MetaData "ListMembersResponse" "Network.AWS.GuardDuty.ListMembers" "amazonka-guardduty-1.6.1-K5KFXxug8mfBfLPNNuAp3C" False) (C1 (MetaCons "ListMembersResponse'" PrefixI True) (S1 (MetaSel (Just "_lmrsMembers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Member])) :*: (S1 (MetaSel (Just "_lmrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

lmrsResponseStatus :: Lens' ListMembersResponse Int Source #

  • - | The response status code.