Amazonka.IdentityStore.ListGroups

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

This operation returns paginated results.

Creating a Request

data ListGroups

See: newListGroups smart constructor.

Constructors

ListGroups'

Fields

• filters :: Maybe [Filter]

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

• maxResults :: Maybe Natural

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

• 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.

• 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 numbers and lower case letters. This value is generated at the time that a new identity store is created.

Instances

ToJSON ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

toJSON :: ListGroups -> Value

toEncoding :: ListGroups -> Encoding

toJSONList :: [ListGroups] -> Value

toEncodingList :: [ListGroups] -> Encoding

ToHeaders ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

toHeaders :: ListGroups -> [Header]

ToPath ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

toPath :: ListGroups -> ByteString

ToQuery ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

toQuery :: ListGroups -> QueryString

AWSPager ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

page :: ListGroups -> AWSResponse ListGroups -> Maybe ListGroups

AWSRequest ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Associated Types

type AWSResponse ListGroups

Methods

request :: (Service -> Service) -> ListGroups -> Request ListGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListGroups)))

Generic ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Associated Types

type Rep ListGroups :: Type -> Type

Methods

from :: ListGroups -> Rep ListGroups x

to :: Rep ListGroups x -> ListGroups

Show ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

showsPrec :: Int -> ListGroups -> ShowS

show :: ListGroups -> String

showList :: [ListGroups] -> ShowS

NFData ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

rnf :: ListGroups -> ()

Eq ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

(==) :: ListGroups -> ListGroups -> Bool

(/=) :: ListGroups -> ListGroups -> Bool

Hashable ListGroups

Defined in Amazonka.IdentityStore.ListGroups

Methods

hashWithSalt :: Int -> ListGroups -> Int

hash :: ListGroups -> Int

type AWSResponse ListGroups

Defined in Amazonka.IdentityStore.ListGroups

type AWSResponse ListGroups = ListGroupsResponse

type Rep ListGroups

Defined in Amazonka.IdentityStore.ListGroups

type Rep ListGroups = D1 ('MetaData "ListGroups" "Amazonka.IdentityStore.ListGroups" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "ListGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identityStoreId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListGroups

Arguments

:: Text

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 requests.

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

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.

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 numbers 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])

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

listGroups_maxResults :: Lens' ListGroups (Maybe Natural)

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

listGroups_nextToken :: Lens' ListGroups (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.

listGroups_identityStoreId :: Lens' ListGroups 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 numbers and lower case letters. This value is generated at the time that a new identity store is created.

Destructuring the Response

data ListGroupsResponse

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

Generic ListGroupsResponse

Defined in Amazonka.IdentityStore.ListGroups

Associated Types

type Rep ListGroupsResponse :: Type -> Type

Methods

from :: ListGroupsResponse -> Rep ListGroupsResponse x

to :: Rep ListGroupsResponse x -> ListGroupsResponse

Show ListGroupsResponse

Defined in Amazonka.IdentityStore.ListGroups

Methods

showsPrec :: Int -> ListGroupsResponse -> ShowS

show :: ListGroupsResponse -> String

showList :: [ListGroupsResponse] -> ShowS

NFData ListGroupsResponse

Defined in Amazonka.IdentityStore.ListGroups

Methods

rnf :: ListGroupsResponse -> ()

Eq ListGroupsResponse

Defined in Amazonka.IdentityStore.ListGroups

Methods

(==) :: ListGroupsResponse -> ListGroupsResponse -> Bool

(/=) :: ListGroupsResponse -> ListGroupsResponse -> Bool

type Rep ListGroupsResponse

Defined in Amazonka.IdentityStore.ListGroups

type Rep ListGroupsResponse = D1 ('MetaData "ListGroupsResponse" "Amazonka.IdentityStore.ListGroups" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" '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

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:

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)

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

The response's http status code.

listGroupsResponse_groups :: Lens' ListGroupsResponse [Group]

A list of Group objects in the identity store.