AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

If you have administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginListGroups and EndListGroups.

Namespace: Amazon.IdentityStore
Assembly: AWSSDK.IdentityStore.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<ListGroupsResponse> ListGroupsAsync(
         ListGroupsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.IdentityStore.Model.ListGroupsRequest

Container for the necessary parameters to execute the ListGroups service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the ListGroups service method, as returned by IdentityStore.

Exceptions

ExceptionCondition
AccessDeniedException You do not have sufficient access to perform this action.
InternalServerException The request processing has failed because of an unknown error, exception or failure with an internal server.
ResourceNotFoundException Indicates that a requested resource is not found.
ThrottlingException Indicates that the principal has crossed the throttling limits of the API operations.
ValidationException The request failed because it contains a syntax error.

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

See Also