get_members `async` ¶

get_members(
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
    account_ids: Optional[AccountIdList] = None,
) -> GetMembersResponse

Returns the details for the Security Hub CSPM member accounts for the specified account IDs.

An administrator account can be either the delegated Security Hub CSPM administrator account for an organization or an administrator account that enabled Security Hub CSPM manually.

The results include both member accounts that are managed using Organizations and accounts that were invited manually.

Parameters:

account_ids (Optional[AccountIdList], default: None ) –

The list of account IDs for the Security Hub CSPM member accounts to return the details for.

Raises:

InternalException –

Internal server error.
InvalidAccessException –

The account doesn't have permission to perform this action.
InvalidInputException –

The request was rejected because you supplied an invalid or out-of-range value for an input parameter.
LimitExceededException –

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.
ResourceNotFoundException –

The request was rejected because we can't find the specified resource.
UnknownServiceError –

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

Source code in docs_src/capo_securityhub/_services/async_security_hub.py

async def get_members(
    self,
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
    account_ids: Optional[
        "capo_securityhub.types.account_id_list.AccountIdList"
    ] = None,
) -> "capo_securityhub.types.get_members_response.GetMembersResponse":
    """<p>Returns the details for the Security Hub CSPM member accounts for the specified account IDs.</p> <p>An administrator account can be either the delegated Security Hub CSPM administrator account for an organization or an administrator account that enabled Security Hub CSPM manually.</p> <p>The results include both member accounts that are managed using Organizations and accounts that were invited manually.</p>

    Args:
        account_ids: <p>The list of account IDs for the Security Hub CSPM member accounts to return the details for. </p>

    Raises:
        capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
        capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
        capo_securityhub.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</p>
        capo_securityhub.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because we can't find the specified resource.</p>
        capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_securityhub.types.get_members_request.GetMembersRequest]",
    ) -> AsyncOperationResponse[
        "capo_securityhub.types.get_members_response.GetMembersResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.get_members

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetMembers")
    )
    input_: capo_securityhub.types.get_members_request.GetMembersRequest = {}
    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` ¶