associate_proactive_engagement_details `async` ¶

associate_proactive_engagement_details(
    emergency_contact_list: EmergencyContactList,
    *,
    config_overrides: Optional[AsyncShieldClientConfig] = None,
) -> AssociateProactiveEngagementDetailsResponse

Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.

After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls DisableProactiveEngagement and EnableProactiveEngagement.

This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.

The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it to this call.

Parameters:

emergency_contact_list (EmergencyContactList) –

A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support.

To enable proactive engagement, the contact list must include at least one phone number.

The contacts that you provide here replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and then provide it here.

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/async_shield.py

async def associate_proactive_engagement_details(
    self,
    emergency_contact_list: "capo_shield.types.emergency_contact_list.EmergencyContactList",
    *,
    config_overrides: Optional[AsyncShieldClientConfig] = None,
) -> "capo_shield.types.associate_proactive_engagement_details_response.AssociateProactiveEngagementDetailsResponse":
    """<p>Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list. </p> <p>After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use the calls <code>DisableProactiveEngagement</code> and <code>EnableProactiveEngagement</code>. </p> <note> <p>This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.</p> <p>The contacts that you provide in the request replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using <code>DescribeEmergencyContactSettings</code> and then provide it to this call. </p> </note>

    Args:
        emergency_contact_list: <p>A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you for escalations to the SRT and to initiate proactive customer support. </p> <p>To enable proactive engagement, the contact list must include at least one phone number.</p> <note> <p>The contacts that you provide here replace any contacts that were already defined. If you already have contacts defined and want to use them, retrieve the list using <code>DescribeEmergencyContactSettings</code> and then provide it here. </p> </note>

    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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_shield.types.associate_proactive_engagement_details_request.AssociateProactiveEngagementDetailsRequest]",
    ) -> AsyncOperationResponse[
        "capo_shield.types.associate_proactive_engagement_details_response.AssociateProactiveEngagementDetailsResponse"
    ]:
        import capo_shield._operations.aws_shield_20160616.associate_proactive_engagement_details

        (
            output,
            http_response,
        ) = await capo_shield._operations.aws_shield_20160616.associate_proactive_engagement_details.async_associate_proactive_engagement_details(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AssociateProactiveEngagementDetails")
    )
    input_: capo_shield.types.associate_proactive_engagement_details_request.AssociateProactiveEngagementDetailsRequest = {
        "emergency_contact_list": emergency_contact_list
    }

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

associate_proactive_engagement_details async ¶

associate_proactive_engagement_details `async` ¶