Container for the parameters to the ListGroups operation.
Given a user pool ID, returns user pool groups and their details.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests
for this API operation. For this operation, you must use IAM credentials to authorize
requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CognitoIdentityProvider.AmazonCognitoIdentityProviderRequest
Amazon.CognitoIdentityProvider.Model.ListGroupsRequest
Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z
Syntax
public class ListGroupsRequest : AmazonCognitoIdentityProviderRequest IAmazonWebServiceRequest
The ListGroupsRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
ListGroupsRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Limit | System.Int32 |
Gets and sets the property Limit. The maximum number of groups that you want Amazon Cognito to return in the response. |
|
|
NextToken | System.String |
Gets and sets the property NextToken. This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items. |
|
|
UserPoolId | System.String |
Gets and sets the property UserPoolId. The ID of the user pool where you want to list user groups. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5