Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.WorkDocs.DescribeGroups

Contents

Description

Describes the groups specified by query.

Creating a Request

describeGroups Source #

Arguments

:: Text	`dgSearchQuery`
-> DescribeGroups

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

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

dgAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
dgMarker - The marker for the next set of results. (You received this marker from a previous call.)
dgLimit - The maximum number of items to return with this call.
dgOrganizationId - The ID of the organization.
dgSearchQuery - A query to describe groups by group name.

data DescribeGroups Source #

See: describeGroups smart constructor.

Instances

Eq DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods (==) :: DescribeGroups -> DescribeGroups -> Bool # (/=) :: DescribeGroups -> DescribeGroups -> Bool #
Data DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGroups -> c DescribeGroups # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGroups # toConstr :: DescribeGroups -> Constr # dataTypeOf :: DescribeGroups -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGroups) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGroups) # gmapT :: (forall b. Data b => b -> b) -> DescribeGroups -> DescribeGroups # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGroups -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGroups -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeGroups -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGroups -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGroups -> m DescribeGroups # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGroups -> m DescribeGroups # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGroups -> m DescribeGroups #
Show DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods showsPrec :: Int -> DescribeGroups -> ShowS # show :: DescribeGroups -> String # showList :: [DescribeGroups] -> ShowS #
Generic DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Associated Types type Rep DescribeGroups :: Type -> Type # Methods from :: DescribeGroups -> Rep DescribeGroups x # to :: Rep DescribeGroups x -> DescribeGroups #
Hashable DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods hashWithSalt :: Int -> DescribeGroups -> Int # hash :: DescribeGroups -> Int #
AWSRequest DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Associated Types type Rs DescribeGroups :: Type # Methods request :: DescribeGroups -> Request DescribeGroups # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeGroups -> ClientResponse -> m (Response DescribeGroups) #
ToHeaders DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods toHeaders :: DescribeGroups -> [Header] #
ToPath DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods toPath :: DescribeGroups -> ByteString #
ToQuery DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods toQuery :: DescribeGroups -> QueryString #
NFData DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods rnf :: DescribeGroups -> () #
type Rep DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups type Rep DescribeGroups = D1 (MetaData "DescribeGroups" "Network.AWS.WorkDocs.DescribeGroups" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DescribeGroups'" PrefixI True) ((S1 (MetaSel (Just "_dgAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 (MetaSel (Just "_dgMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_dgLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :: (S1 (MetaSel (Just "_dgOrganizationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dgSearchQuery") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text))))))
type Rs DescribeGroups Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups type Rs DescribeGroups = DescribeGroupsResponse

Request Lenses

dgAuthenticationToken :: Lens' DescribeGroups (Maybe Text) Source #

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

dgMarker :: Lens' DescribeGroups (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

dgLimit :: Lens' DescribeGroups (Maybe Natural) Source #

The maximum number of items to return with this call.

dgOrganizationId :: Lens' DescribeGroups (Maybe Text) Source #

The ID of the organization.

dgSearchQuery :: Lens' DescribeGroups Text Source #

A query to describe groups by group name.

Destructuring the Response

describeGroupsResponse Source #

Arguments

:: Int	`dgrsResponseStatus`
-> DescribeGroupsResponse

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

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

dgrsGroups - The list of groups.
dgrsMarker - The marker to use when requesting the next set of results. If there are no additional results, the string is empty.
dgrsResponseStatus - -- | The response status code.

data DescribeGroupsResponse Source #

See: describeGroupsResponse smart constructor.

Instances

Eq DescribeGroupsResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods (==) :: DescribeGroupsResponse -> DescribeGroupsResponse -> Bool # (/=) :: DescribeGroupsResponse -> DescribeGroupsResponse -> Bool #
Data DescribeGroupsResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGroupsResponse -> c DescribeGroupsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGroupsResponse # toConstr :: DescribeGroupsResponse -> Constr # dataTypeOf :: DescribeGroupsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGroupsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGroupsResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeGroupsResponse -> DescribeGroupsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGroupsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGroupsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeGroupsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGroupsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGroupsResponse -> m DescribeGroupsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGroupsResponse -> m DescribeGroupsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGroupsResponse -> m DescribeGroupsResponse #
Read DescribeGroupsResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods readsPrec :: Int -> ReadS DescribeGroupsResponse # readList :: ReadS [DescribeGroupsResponse] # readPrec :: ReadPrec DescribeGroupsResponse # readListPrec :: ReadPrec [DescribeGroupsResponse] #
Show DescribeGroupsResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods showsPrec :: Int -> DescribeGroupsResponse -> ShowS # show :: DescribeGroupsResponse -> String # showList :: [DescribeGroupsResponse] -> ShowS #
Generic DescribeGroupsResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Associated Types type Rep DescribeGroupsResponse :: Type -> Type # Methods from :: DescribeGroupsResponse -> Rep DescribeGroupsResponse x # to :: Rep DescribeGroupsResponse x -> DescribeGroupsResponse #
NFData DescribeGroupsResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups Methods rnf :: DescribeGroupsResponse -> () #
type Rep DescribeGroupsResponse Source #
Instance details Defined in Network.AWS.WorkDocs.DescribeGroups type Rep DescribeGroupsResponse = D1 (MetaData "DescribeGroupsResponse" "Network.AWS.WorkDocs.DescribeGroups" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DescribeGroupsResponse'" PrefixI True) (S1 (MetaSel (Just "_dgrsGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GroupMetadata])) :: (S1 (MetaSel (Just "_dgrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dgrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dgrsGroups :: Lens' DescribeGroupsResponse [GroupMetadata] Source #

The list of groups.

dgrsMarker :: Lens' DescribeGroupsResponse (Maybe Text) Source #

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

dgrsResponseStatus :: Lens' DescribeGroupsResponse Int Source #

- | The response status code.