Shield / Client / associate_proactive_engagement_details

associate_proactive_engagement_details#

Shield.Client.associate_proactive_engagement_details(**kwargs)#

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.

Note

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.

Request Syntax

response = client.associate_proactive_engagement_details(
    EmergencyContactList=[
        {
            'EmailAddress': 'string',
            'PhoneNumber': 'string',
            'ContactNotes': 'string'
        },
    ]
)

Parameters:

EmergencyContactList (list) –

[REQUIRED]

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.

Note

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.

(dict) –

Contact information that the SRT can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
- EmailAddress (string) – [REQUIRED]
  
  The email address for the contact.
- PhoneNumber (string) –
  
  The phone number for the contact.
- ContactNotes (string) –
  
  Additional notes regarding the contact.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

Shield.Client.exceptions.InternalErrorException
Shield.Client.exceptions.InvalidOperationException
Shield.Client.exceptions.InvalidParameterException
Shield.Client.exceptions.ResourceNotFoundException
Shield.Client.exceptions.OptimisticLockException