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.WorkDocs.DescribeGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

This operation returns paginated results.

Synopsis

data DescribeGroups = DescribeGroups' {
- authenticationToken :: Maybe (Sensitive Text)
- limit :: Maybe Natural
- marker :: Maybe Text
- organizationId :: Maybe Text
- searchQuery :: Sensitive Text
}
newDescribeGroups :: Text -> DescribeGroups
describeGroups_authenticationToken :: Lens' DescribeGroups (Maybe Text)
describeGroups_limit :: Lens' DescribeGroups (Maybe Natural)
describeGroups_marker :: Lens' DescribeGroups (Maybe Text)
describeGroups_organizationId :: Lens' DescribeGroups (Maybe Text)
describeGroups_searchQuery :: Lens' DescribeGroups Text
data DescribeGroupsResponse = DescribeGroupsResponse' {
- groups :: Maybe [GroupMetadata]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeGroupsResponse :: Int -> DescribeGroupsResponse
describeGroupsResponse_groups :: Lens' DescribeGroupsResponse (Maybe [GroupMetadata])
describeGroupsResponse_marker :: Lens' DescribeGroupsResponse (Maybe Text)
describeGroupsResponse_httpStatus :: Lens' DescribeGroupsResponse Int

Creating a Request

data DescribeGroups Source #

See: newDescribeGroups smart constructor.

Constructors

DescribeGroups'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
limit :: Maybe Natural
The maximum number of items to return with this call.
marker :: Maybe Text
The marker for the next set of results. (You received this marker from a previous call.)
organizationId :: Maybe Text
The ID of the organization.
searchQuery :: Sensitive Text
A query to describe groups by group name.

Instances

Instances details

ToHeaders DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods toHeaders :: DescribeGroups -> [Header] #
ToPath DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods toPath :: DescribeGroups -> ByteString #
ToQuery DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods toQuery :: DescribeGroups -> QueryString #
AWSPager DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods page :: DescribeGroups -> AWSResponse DescribeGroups -> Maybe DescribeGroups #
AWSRequest DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Associated Types type AWSResponse DescribeGroups # Methods request :: (Service -> Service) -> DescribeGroups -> Request DescribeGroups # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGroups))) #
Generic DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Associated Types type Rep DescribeGroups :: Type -> Type # Methods from :: DescribeGroups -> Rep DescribeGroups x # to :: Rep DescribeGroups x -> DescribeGroups #
Show DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods showsPrec :: Int -> DescribeGroups -> ShowS # show :: DescribeGroups -> String # showList :: [DescribeGroups] -> ShowS #
NFData DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods rnf :: DescribeGroups -> () #
Eq DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods (==) :: DescribeGroups -> DescribeGroups -> Bool # (/=) :: DescribeGroups -> DescribeGroups -> Bool #
Hashable DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods hashWithSalt :: Int -> DescribeGroups -> Int # hash :: DescribeGroups -> Int #
type AWSResponse DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups type AWSResponse DescribeGroups = DescribeGroupsResponse
type Rep DescribeGroups Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups type Rep DescribeGroups = D1 ('MetaData "DescribeGroups" "Amazonka.WorkDocs.DescribeGroups" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "searchQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newDescribeGroups Source #

Arguments

:: Text	`$sel:searchQuery:DescribeGroups'`
-> DescribeGroups

Create a value of DescribeGroups 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:authenticationToken:DescribeGroups', describeGroups_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:limit:DescribeGroups', describeGroups_limit - The maximum number of items to return with this call.

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

DescribeGroups, describeGroups_organizationId - The ID of the organization.

$sel:searchQuery:DescribeGroups', describeGroups_searchQuery - A query to describe groups by group name.

Request Lenses

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

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

The maximum number of items to return with this call.

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

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

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

The ID of the organization.

describeGroups_searchQuery :: Lens' DescribeGroups Text Source #

A query to describe groups by group name.

Destructuring the Response

data DescribeGroupsResponse Source #

See: newDescribeGroupsResponse smart constructor.

Constructors

DescribeGroupsResponse'
Fields groups :: Maybe [GroupMetadata] The list of groups. marker :: Maybe Text The marker to use when requesting the next set of results. If there are no additional results, the string is empty. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeGroupsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Associated Types type Rep DescribeGroupsResponse :: Type -> Type # Methods from :: DescribeGroupsResponse -> Rep DescribeGroupsResponse x # to :: Rep DescribeGroupsResponse x -> DescribeGroupsResponse #
Read DescribeGroupsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods readsPrec :: Int -> ReadS DescribeGroupsResponse # readList :: ReadS [DescribeGroupsResponse] # readPrec :: ReadPrec DescribeGroupsResponse # readListPrec :: ReadPrec [DescribeGroupsResponse] #
Show DescribeGroupsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods showsPrec :: Int -> DescribeGroupsResponse -> ShowS # show :: DescribeGroupsResponse -> String # showList :: [DescribeGroupsResponse] -> ShowS #
NFData DescribeGroupsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods rnf :: DescribeGroupsResponse -> () #
Eq DescribeGroupsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups Methods (==) :: DescribeGroupsResponse -> DescribeGroupsResponse -> Bool # (/=) :: DescribeGroupsResponse -> DescribeGroupsResponse -> Bool #
type Rep DescribeGroupsResponse Source #
Instance details Defined in Amazonka.WorkDocs.DescribeGroups type Rep DescribeGroupsResponse = D1 ('MetaData "DescribeGroupsResponse" "Amazonka.WorkDocs.DescribeGroups" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DescribeGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GroupMetadata])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeGroupsResponse Source #

Arguments

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

Create a value of DescribeGroupsResponse 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:

DescribeGroupsResponse, describeGroupsResponse_groups - The list of groups.

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

$sel:httpStatus:DescribeGroupsResponse', describeGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeGroupsResponse_groups :: Lens' DescribeGroupsResponse (Maybe [GroupMetadata]) Source #

The list of groups.

describeGroupsResponse_marker :: 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.

describeGroupsResponse_httpStatus :: Lens' DescribeGroupsResponse Int Source #

The response's http status code.