list_group_members ¶

list_group_members(
    organization_id: OrganizationId,
    group_id: EntityIdentifier,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListGroupMembersResponse

Returns an overview of the members of a group. Users and groups can be members of a group.

Parameters:

organization_id (OrganizationId) –

The identifier for the organization under which the group exists.
group_id (EntityIdentifier) –
The identifier for the group to which the members (users or groups) are associated.

The identifier can accept GroupId, Groupname, or email. The following identity formats are available:
- Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234
- Email address: [email protected]
- Group name: group
next_token (Optional[NextToken], default: None ) –

The token to use to retrieve the next page of results. The first call does not contain any tokens.
max_results (Optional[MaxResults], default: None ) –

The maximum number of results to return in a single call.

Raises:

EntityNotFoundException –

The identifier supplied for the user, group, or resource does not exist in your organization.
EntityStateException –

You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.
InvalidParameterException –

One or more of the input parameters don't match the service's restrictions.
OrganizationNotFoundException –

An operation received a valid organization identifier that either doesn't belong or exist in the system.
OrganizationStateException –

The organization must have a valid state to perform certain operations on the organization or its members.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_workmail/_services/work_mail.py

def list_group_members(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    group_id: "capo_workmail.types.entity_identifier.EntityIdentifier",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    next_token: Optional["capo_workmail.types.next_token.NextToken"] = None,
    max_results: Optional["capo_workmail.types.max_results.MaxResults"] = None,
) -> "capo_workmail.types.list_group_members_response.ListGroupMembersResponse":
    """<p>Returns an overview of the members of a group. Users and groups can be members of a group.</p>

    Args:
        organization_id: <p>The identifier for the organization under which the group exists.</p>
        group_id: <p>The identifier for the group to which the members (users or groups) are associated.</p> <p>The identifier can accept <i>GroupId</i>, <i>Groupname</i>, or <i>email</i>. The following identity formats are available:</p> <ul> <li> <p>Group ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234</p> </li> <li> <p>Email address: [email protected]</p> </li> <li> <p>Group name: group</p> </li> </ul>
        next_token: <p> The token to use to retrieve the next page of results. The first call does not contain any tokens.</p>
        max_results: <p>The maximum number of results to return in a single call.</p>

    Raises:
        capo_workmail.errors.entity_not_found_exception.EntityNotFoundException: <p>The identifier supplied for the user, group, or resource does not exist in your organization.</p>
        capo_workmail.errors.entity_state_exception.EntityStateException: <p>You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.</p>
        capo_workmail.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the input parameters don't match the service's restrictions.</p>
        capo_workmail.errors.organization_not_found_exception.OrganizationNotFoundException: <p>An operation received a valid organization identifier that either doesn't belong or exist in the system.</p>
        capo_workmail.errors.organization_state_exception.OrganizationStateException: <p>The organization must have a valid state to perform certain operations on the organization or its members.</p>
        capo_workmail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.list_group_members_request.ListGroupMembersRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.list_group_members_response.ListGroupMembersResponse"
    ]:
        import capo_workmail._operations.work_mail_service.list_group_members

        output, http_response = (
            capo_workmail._operations.work_mail_service.list_group_members.list_group_members(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListGroupMembers")
    )
    input_: capo_workmail.types.list_group_members_request.ListGroupMembersRequest = {
        "organization_id": organization_id,
        "group_id": group_id,
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output