ListGroupMembershipsForMember - Identity Store

ListGroupMembershipsForMember

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

Request Syntax

{ "IdentityStoreId": "string", "MaxResults": number, "MemberId": { "UserId": "string" }, "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

IdentityStoreId

The globally unique identifier for the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

MemberId

An object that contains the identifier of a group member. Setting the UserID field to the specific identifier for a user indicates that the user is a member of the group.

Type: MemberId object

Required: Yes

NextToken

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65535.

Pattern: [-a-zA-Z0-9+=/:]*

Required: No

Response Syntax

{ "GroupMemberships": [ { "GroupId": "string", "IdentityStoreId": "string", "MemberId": { "UserId": "string" }, "MembershipId": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

GroupMemberships

A list of GroupMembership objects in the group for a specified member.

Type: Array of GroupMembership objects

NextToken

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships 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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65535.

Pattern: [-a-zA-Z0-9+=/:]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure with an internal server.

HTTP Status Code: 500

ResourceNotFoundException

Indicates that a requested resource is not found.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: