get_members `async` ¶

get_members(
    detector_id: DetectorId,
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    account_ids: Optional[AccountIds] = None,
) -> GetMembersResponse

Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.

Parameters:

detector_id (DetectorId) –

The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

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

A list of account IDs of the GuardDuty member accounts that you want to describe.

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 get_members(
    self,
    detector_id: "capo_guardduty.types.detector_id.DetectorId",
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    account_ids: Optional["capo_guardduty.types.account_ids.AccountIds"] = None,
) -> "capo_guardduty.types.get_members_response.GetMembersResponse":
    """<p>Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.</p>

    Args:
        detector_id: <p>The unique ID of the detector of the GuardDuty account whose members you want to retrieve.</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>
        account_ids: <p>A list of account IDs of the GuardDuty member accounts that you want to describe.</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.get_members_request.GetMembersRequest]",
    ) -> AsyncOperationResponse[
        "capo_guardduty.types.get_members_response.GetMembersResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.get_members

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

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

        return capo_guardduty.types.get_members_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("GetMembers", redact_output=_redact_output),
    )
    input_: capo_guardduty.types.get_members_request.GetMembersRequest = {
        "detector_id": detector_id
    }
    if account_ids is not None:
        input_["account_ids"] = account_ids

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

get_members async ¶

get_members `async` ¶