Skip to content

update_ec2_deep_inspection_configuration

update_ec2_deep_inspection_configuration(
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    activate_deep_inspection: Optional[bool] = None,
    package_paths: Optional[PathList] = None,
) -> UpdateEc2DeepInspectionConfigurationResponse

Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account.

Parameters:

  • activate_deep_inspection (Optional[bool], default: None ) –

    Specify TRUE to activate Amazon Inspector deep inspection in your account, or FALSE to deactivate. Member accounts in an organization cannot deactivate deep inspection, instead the delegated administrator for the organization can deactivate a member account using BatchUpdateMemberEc2DeepInspectionStatus.

  • package_paths (Optional[PathList], default: None ) –

    The Amazon Inspector deep inspection custom paths you are adding for your account.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

    For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

  • InternalServerException –

    The request has failed due to an internal failure of the Amazon Inspector service.

  • ThrottlingException –

    The limit on the number of requests per second was exceeded.

  • ValidationException –

    The request has failed validation due to missing required fields or having invalid inputs.

  • UnknownServiceError –

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

Source code in docs_src/capo_inspector2/_services/inspector2.py
def update_ec2_deep_inspection_configuration(
    self,
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    activate_deep_inspection: Optional[bool] = None,
    package_paths: Optional["capo_inspector2.types.path_list.PathList"] = None,
) -> "capo_inspector2.types.update_ec2_deep_inspection_configuration_response.UpdateEc2DeepInspectionConfigurationResponse":
    """<p>Activates, deactivates Amazon Inspector deep inspection, or updates custom paths for your account. </p>

    Args:
        activate_deep_inspection: <p>Specify <code>TRUE</code> to activate Amazon Inspector deep inspection in your account, or <code>FALSE</code> to deactivate. Member accounts in an organization cannot deactivate deep inspection, instead the delegated administrator for the organization can deactivate a member account using <a href="https://docs.aws.amazon.com/inspector/v2/APIReference/API_BatchUpdateMemberEc2DeepInspectionStatus.html">BatchUpdateMemberEc2DeepInspectionStatus</a>.</p>
        package_paths: <p>The Amazon Inspector deep inspection custom paths you are adding for your account.</p>

    Raises:
        capo_inspector2.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p> For <code>Enable</code>, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region. </p>
        capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
        capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
        capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_inspector2.types.update_ec2_deep_inspection_configuration_request.UpdateEc2DeepInspectionConfigurationRequest]",
    ) -> OperationResponse[
        "capo_inspector2.types.update_ec2_deep_inspection_configuration_response.UpdateEc2DeepInspectionConfigurationResponse"
    ]:
        import capo_inspector2._operations.inspector2.update_ec2_deep_inspection_configuration

        output, http_response = (
            capo_inspector2._operations.inspector2.update_ec2_deep_inspection_configuration.update_ec2_deep_inspection_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateEc2DeepInspectionConfiguration")
    )
    input_: capo_inspector2.types.update_ec2_deep_inspection_configuration_request.UpdateEc2DeepInspectionConfigurationRequest = {}
    if activate_deep_inspection is not None:
        input_["activate_deep_inspection"] = activate_deep_inspection
    if package_paths is not None:
        input_["package_paths"] = package_paths

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