list_members `async` ¶

list_members(
    detector_id: DetectorId,
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[String] = None,
    only_associated: Optional[String] = None,
) -> ListMembersResponse

Lists details about all member accounts for the current GuardDuty administrator account.

Parameters:

detector_id (DetectorId) –

The unique ID of the detector that is associated with the member.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
max_results (Optional[MaxResults], default: None ) –

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
next_token (Optional[String], default: None ) –

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
only_associated (Optional[String], default: None ) –

Specifies whether to only return associated members or to return all members (including members who haven't been invited yet or have been disassociated). Member accounts must have been previously associated with the GuardDuty administrator account using Create Members .

Raises:

BadRequestException –

A bad request exception object.
InternalServerErrorException –

An internal server error exception object.
UnknownServiceError –

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

Source code in docs_src/capo_guardduty/_services/async_guard_duty.py

async def list_members(
    self,
    detector_id: "capo_guardduty.types.detector_id.DetectorId",
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    max_results: Optional["capo_guardduty.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_guardduty.types.string.String"] = None,
    only_associated: Optional["capo_guardduty.types.string.String"] = None,
) -> "capo_guardduty.types.list_members_response.ListMembersResponse":
    """<p>Lists details about all member accounts for the current GuardDuty administrator account.</p>

    Args:
        detector_id: <p>The unique ID of the detector that is associated with the member.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
        max_results: <p>You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.</p>
        next_token: <p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>
        only_associated: <p>Specifies whether to only return associated members or to return all members (including members who haven't been invited yet or have been disassociated). Member accounts must have been previously associated with the GuardDuty administrator account using <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_CreateMembers.html"> <code>Create Members</code> </a>. </p>

    Raises:
        capo_guardduty.errors.bad_request_exception.BadRequestException: <p>A bad request exception object.</p>
        capo_guardduty.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal server error exception object.</p>
        capo_guardduty.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_guardduty.types.list_members_request.ListMembersRequest]",
    ) -> AsyncOperationResponse[
        "capo_guardduty.types.list_members_response.ListMembersResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.list_members

        (
            output,
            http_response,
        ) = await capo_guardduty._operations.guard_duty_api_service.list_members.async_list_members(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_guardduty.types.list_members_response.ListMembersResponse",
    ) -> dict[str, Any]:
        import capo_guardduty.types.list_members_response

        return capo_guardduty.types.list_members_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListMembers", redact_output=_redact_output),
    )
    input_: capo_guardduty.types.list_members_request.ListMembersRequest = {
        "detector_id": detector_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if only_associated is not None:
        input_["only_associated"] = only_associated

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_members async ¶

list_members `async` ¶