For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.
If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.
Parameters:
-
identity_store_id
(IdentityStoreId)
–
The globally unique identifier for the identity store.
You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.
-
group_id
(ResourceId)
–
The identifier for a group in the identity store.
You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID a1b2c3d4-5678-90ab-cdef-EXAMPLE22222 or group ARN arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.
-
next_token
(Optional[NextToken], default:
None
)
–
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 retrieve the next page of results.
Raises:
Source code in docs_src/capo_identitystore/_services/identitystore.py
| def list_group_memberships(
self,
identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId",
group_id: "capo_identitystore.types.resource_id.ResourceId",
*,
config_overrides: Optional[identitystoreClientConfig] = None,
max_results: Optional["capo_identitystore.types.max_results.MaxResults"] = None,
next_token: Optional["capo_identitystore.types.next_token.NextToken"] = None,
) -> "capo_identitystore.types.list_group_memberships_response.ListGroupMembershipsResponse":
"""<p>For the specified group in the specified identity store, returns the list of all <code> GroupMembership</code> objects and returns results in paginated form.</p> <note> <p>If you have access to a member account, you can use this API operation from the member account. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts">Limiting access to the identity store from member accounts</a> in the <i> IAM Identity Center User Guide</i>.</p> </note>
Args:
identity_store_id: <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
group_id: <p>The identifier for a group in the identity store.</p> <p>You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
max_results: <p>The maximum number of results to be returned per request. This parameter is used in all <code> List</code> requests to specify how many results to return in one page.</p>
next_token: <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code> and <code> ListGroupMemberships</code> 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 retrieve the next page of results.</p>
Raises:
capo_identitystore.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_identitystore.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
capo_identitystore.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
capo_identitystore.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
capo_identitystore.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
capo_identitystore.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_identitystore.types.list_group_memberships_request.ListGroupMembershipsRequest]",
) -> OperationResponse[
"capo_identitystore.types.list_group_memberships_response.ListGroupMembershipsResponse"
]:
import capo_identitystore._operations.aws_identity_store.list_group_memberships
output, http_response = (
capo_identitystore._operations.aws_identity_store.list_group_memberships.list_group_memberships(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListGroupMemberships")
)
input_: capo_identitystore.types.list_group_memberships_request.ListGroupMembershipsRequest = {
"identity_store_id": identity_store_id,
"group_id": group_id,
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|