enable_proactive_engagement ¶

enable_proactive_engagement(
    *, config_overrides: Optional[ShieldClientConfig] = None
) -> EnableProactiveEngagementResponse

Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.

Raises:

InternalErrorException –

Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.
InvalidOperationException –

Exception that indicates that the operation would not cause any change to occur.
InvalidParameterException –

Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties.
OptimisticLockException –

Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.
ResourceNotFoundException –

Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties.
UnknownServiceError –

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

Source code in docs_src/capo_shield/_services/shield.py

def enable_proactive_engagement(
    self, *, config_overrides: Optional[ShieldClientConfig] = None
) -> "capo_shield.types.enable_proactive_engagement_response.EnableProactiveEngagementResponse":
    """<p>Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.</p>

    Raises:
        capo_shield.errors.internal_error_exception.InternalErrorException: <p>Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.</p>
        capo_shield.errors.invalid_operation_exception.InvalidOperationException: <p>Exception that indicates that the operation would not cause any change to occur.</p>
        capo_shield.errors.invalid_parameter_exception.InvalidParameterException: <p>Exception that indicates that the parameters passed to the API are invalid. If available, this exception includes details in additional properties. </p>
        capo_shield.errors.optimistic_lock_exception.OptimisticLockException: <p>Exception that indicates that the resource state has been modified by another client. Retrieve the resource and then retry your request.</p>
        capo_shield.errors.resource_not_found_exception.ResourceNotFoundException: <p>Exception indicating the specified resource does not exist. If available, this exception includes details in additional properties. </p>
        capo_shield.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_shield.types.enable_proactive_engagement_request.EnableProactiveEngagementRequest]",
    ) -> OperationResponse[
        "capo_shield.types.enable_proactive_engagement_response.EnableProactiveEngagementResponse"
    ]:
        import capo_shield._operations.aws_shield_20160616.enable_proactive_engagement

        output, http_response = (
            capo_shield._operations.aws_shield_20160616.enable_proactive_engagement.enable_proactive_engagement(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EnableProactiveEngagement")
    )
    input_: capo_shield.types.enable_proactive_engagement_request.EnableProactiveEngagementRequest = {}

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