Skip to content

start_monitoring_member

start_monitoring_member(
    graph_arn: GraphArn,
    account_id: AccountId,
    *,
    config_overrides: Optional[DetectiveClientConfig] = None,
) -> None

Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED.

For valid member accounts, the status is updated as follows.

  • If Detective enabled the member account, then the new status is ENABLED.

  • If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.

Parameters:

  • graph_arn (GraphArn) –

    The ARN of the behavior graph.

  • account_id (AccountId) –

    The account ID of the member account to try to enable.

    The account must be an invited member account with a status of ACCEPTED_BUT_DISABLED.

Raises:

  • AccessDeniedException –

    The request issuer does not have permission to access this resource or perform this operation.

  • ConflictException –

    The request attempted an invalid action.

  • InternalServerException –

    The request was valid but failed because of a problem with the service.

  • ResourceNotFoundException –

    The request refers to a nonexistent resource.

  • ServiceQuotaExceededException –

    This request cannot be completed for one of the following reasons.

    • This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.

    • This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.

  • ValidationException –

    The request parameters are invalid.

  • UnknownServiceError –

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

Source code in docs_src/capo_detective/_services/detective.py
def start_monitoring_member(
    self,
    graph_arn: "capo_detective.types.graph_arn.GraphArn",
    account_id: "capo_detective.types.account_id.AccountId",
    *,
    config_overrides: Optional[DetectiveClientConfig] = None,
) -> None:
    """<p>Sends a request to enable data ingest for a member account that has a status of <code>ACCEPTED_BUT_DISABLED</code>.</p> <p>For valid member accounts, the status is updated as follows.</p> <ul> <li> <p>If Detective enabled the member account, then the new status is <code>ENABLED</code>.</p> </li> <li> <p>If Detective cannot enable the member account, the status remains <code>ACCEPTED_BUT_DISABLED</code>. </p> </li> </ul>

    Args:
        graph_arn: <p>The ARN of the behavior graph.</p>
        account_id: <p>The account ID of the member account to try to enable.</p> <p>The account must be an invited member account with a status of <code>ACCEPTED_BUT_DISABLED</code>. </p>

    Raises:
        capo_detective.errors.access_denied_exception.AccessDeniedException: <p>The request issuer does not have permission to access this resource or perform this operation.</p>
        capo_detective.errors.conflict_exception.ConflictException: <p>The request attempted an invalid action.</p>
        capo_detective.errors.internal_server_exception.InternalServerException: <p>The request was valid but failed because of a problem with the service.</p>
        capo_detective.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request refers to a nonexistent resource.</p>
        capo_detective.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>This request cannot be completed for one of the following reasons.</p> <ul> <li> <p>This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.</p> </li> <li> <p>This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.</p> </li> </ul>
        capo_detective.errors.validation_exception.ValidationException: <p>The request parameters are invalid.</p>
        capo_detective.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_detective.types.start_monitoring_member_request.StartMonitoringMemberRequest]",
    ) -> OperationResponse[None]:
        import capo_detective._operations.amazon_detective.start_monitoring_member

        output, http_response = (
            capo_detective._operations.amazon_detective.start_monitoring_member.start_monitoring_member(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartMonitoringMember")
    )
    input_: capo_detective.types.start_monitoring_member_request.StartMonitoringMemberRequest = {
        "graph_arn": graph_arn,
        "account_id": account_id,
    }

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