Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IdentityStore.ListGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

Synopsis

data ListGroups = ListGroups' {
- filters :: Maybe [Filter]
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- identityStoreId :: Text
}
newListGroups :: Text -> ListGroups
listGroups_filters :: Lens' ListGroups (Maybe [Filter])
listGroups_nextToken :: Lens' ListGroups (Maybe Text)
listGroups_maxResults :: Lens' ListGroups (Maybe Natural)
listGroups_identityStoreId :: Lens' ListGroups Text
data ListGroupsResponse = ListGroupsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- groups :: [Group]
}
newListGroupsResponse :: Int -> ListGroupsResponse
listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text)
listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int
listGroupsResponse_groups :: Lens' ListGroupsResponse [Group]

Creating a Request

data ListGroups Source #

See: newListGroups smart constructor.

Constructors

ListGroups'

Fields

filters :: Maybe [Filter]
A list of Filter objects, which is used in the ListUsers and ListGroups request.
nextToken :: Maybe Text
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.
maxResults :: Maybe Natural
The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.
identityStoreId :: Text
The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

Instances

Instances details

Eq ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods (==) :: ListGroups -> ListGroups -> Bool # (/=) :: ListGroups -> ListGroups -> Bool #
Show ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods showsPrec :: Int -> ListGroups -> ShowS # show :: ListGroups -> String # showList :: [ListGroups] -> ShowS #
Generic ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Associated Types type Rep ListGroups :: Type -> Type # Methods from :: ListGroups -> Rep ListGroups x # to :: Rep ListGroups x -> ListGroups #
NFData ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods rnf :: ListGroups -> () #
Hashable ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods hashWithSalt :: Int -> ListGroups -> Int # hash :: ListGroups -> Int #
ToJSON ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods toJSON :: ListGroups -> Value # toEncoding :: ListGroups -> Encoding # toJSONList :: [ListGroups] -> Value # toEncodingList :: [ListGroups] -> Encoding #
AWSRequest ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Associated Types type AWSResponse ListGroups # Methods request :: ListGroups -> Request ListGroups # response :: MonadResource m => Logger -> Service -> Proxy ListGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGroups))) #
ToHeaders ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods toHeaders :: ListGroups -> [Header] #
ToPath ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods toPath :: ListGroups -> ByteString #
ToQuery ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods toQuery :: ListGroups -> QueryString #
type Rep ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.IdentityStore.ListGroups" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListGroups Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups type AWSResponse ListGroups = ListGroupsResponse

newListGroups Source #

Arguments

:: Text	`$sel:identityStoreId:ListGroups'`
-> ListGroups

Create a value of ListGroups 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:filters:ListGroups', listGroups_filters - A list of Filter objects, which is used in the ListUsers and ListGroups request.

$sel:nextToken:ListGroups', listGroups_nextToken - The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

$sel:maxResults:ListGroups', listGroups_maxResults - The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

$sel:identityStoreId:ListGroups', listGroups_identityStoreId - The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

Request Lenses

listGroups_filters :: Lens' ListGroups (Maybe [Filter]) Source #

A list of Filter objects, which is used in the ListUsers and ListGroups request.

listGroups_nextToken :: Lens' ListGroups (Maybe Text) Source #

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

listGroups_maxResults :: Lens' ListGroups (Maybe Natural) Source #

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups request to specify how many results to return in one page. The length limit is 50 characters.

listGroups_identityStoreId :: Lens' ListGroups Text Source #

The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains number and lower case letters. This value is generated at the time that a new identity store is created.

Destructuring the Response

data ListGroupsResponse Source #

See: newListGroupsResponse smart constructor.

Constructors

ListGroupsResponse'

Fields

nextToken :: Maybe Text
The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.
httpStatus :: Int
The response's http status code.
groups :: [Group]
A list of Group objects in the identity store.

Instances

Instances details

Eq ListGroupsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods (==) :: ListGroupsResponse -> ListGroupsResponse -> Bool # (/=) :: ListGroupsResponse -> ListGroupsResponse -> Bool #
Read ListGroupsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods readsPrec :: Int -> ReadS ListGroupsResponse # readList :: ReadS [ListGroupsResponse] # readPrec :: ReadPrec ListGroupsResponse # readListPrec :: ReadPrec [ListGroupsResponse] #
Show ListGroupsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods showsPrec :: Int -> ListGroupsResponse -> ShowS # show :: ListGroupsResponse -> String # showList :: [ListGroupsResponse] -> ShowS #
Generic ListGroupsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Associated Types type Rep ListGroupsResponse :: Type -> Type # Methods from :: ListGroupsResponse -> Rep ListGroupsResponse x # to :: Rep ListGroupsResponse x -> ListGroupsResponse #
NFData ListGroupsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups Methods rnf :: ListGroupsResponse -> () #
type Rep ListGroupsResponse Source #
Instance details Defined in Amazonka.IdentityStore.ListGroups type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.IdentityStore.ListGroups" "libZSservicesZSamazonka-identitystoreZSamazonka-identitystore" 'False) (C1 ('MetaCons "ListGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "groups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Group]))))

newListGroupsResponse Source #

Arguments

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

Create a value of ListGroupsResponse 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:nextToken:ListGroups', listGroupsResponse_nextToken - The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.

$sel:httpStatus:ListGroupsResponse', listGroupsResponse_httpStatus - The response's http status code.

$sel:groups:ListGroupsResponse', listGroupsResponse_groups - A list of Group objects in the identity store.

Response Lenses

listGroupsResponse_nextToken :: Lens' ListGroupsResponse (Maybe Text) Source #

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.

listGroupsResponse_httpStatus :: Lens' ListGroupsResponse Int Source #

The response's http status code.

listGroupsResponse_groups :: Lens' ListGroupsResponse [Group] Source #

A list of Group objects in the identity store.