2020/06/08 - AWS Shield - 3 new 3 updated api methods
Changes This release adds the option for customers to identify a contact name and method that the DDoS Response Team can proactively engage when a Route 53 Health Check that is associated with a Shield protected resource fails.
Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.
See also: AWS API Documentation
Request Syntax
client.disable_proactive_engagement()
dict
Response Syntax
{}
Response Structure
(dict) --
Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
See also: AWS API Documentation
Request Syntax
client.enable_proactive_engagement()
dict
Response Syntax
{}
Response Structure
(dict) --
Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) 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 DDoS Response Team (DRT) can use to contact you for escalations to the DRT 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.
See also: AWS API Documentation
Request Syntax
client.associate_proactive_engagement_details(
EmergencyContactList=[
{
'EmailAddress': 'string',
'PhoneNumber': 'string',
'ContactNotes': 'string'
},
]
)
list
[REQUIRED]
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you for escalations to the DRT 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 DRT can use to contact you if you have proactive engagement enabled, for escalations to the DRT 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.
dict
Response Syntax
{}
Response Structure
(dict) --
{'EmergencyContactList': {'ContactNotes': 'string', 'PhoneNumber': 'string'}}
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
See also: AWS API Documentation
Request Syntax
client.describe_emergency_contact_settings()
dict
Response Syntax
{
'EmergencyContactList': [
{
'EmailAddress': 'string',
'PhoneNumber': 'string',
'ContactNotes': 'string'
},
]
}
Response Structure
(dict) --
EmergencyContactList (list) --
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
(dict) --
Contact information that the DRT can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
EmailAddress (string) --
The email address for the contact.
PhoneNumber (string) --
The phone number for the contact.
ContactNotes (string) --
Additional notes regarding the contact.
{'Subscription': {'ProactiveEngagementStatus': 'ENABLED | DISABLED | PENDING'}}
Provides details about the AWS Shield Advanced subscription for an account.
See also: AWS API Documentation
Request Syntax
client.describe_subscription()
dict
Response Syntax
{
'Subscription': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'TimeCommitmentInSeconds': 123,
'AutoRenew': 'ENABLED'|'DISABLED',
'Limits': [
{
'Type': 'string',
'Max': 123
},
],
'ProactiveEngagementStatus': 'ENABLED'|'DISABLED'|'PENDING'
}
}
Response Structure
(dict) --
Subscription (dict) --
The AWS Shield Advanced subscription details for an account.
StartTime (datetime) --
The start time of the subscription, in Unix time in seconds. For more information see timestamp .
EndTime (datetime) --
The date and time your subscription will end.
TimeCommitmentInSeconds (integer) --
The length, in seconds, of the AWS Shield Advanced subscription for the account.
AutoRenew (string) --
If ENABLED , the subscription will be automatically renewed at the end of the existing subscription period.
When you initally create a subscription, AutoRenew is set to ENABLED . You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew , the existing value for AutoRenew remains unchanged.
Limits (list) --
Specifies how many protections of a given type you can create.
(dict) --
Specifies how many protections of a given type you can create.
Type (string) --
The type of protection.
Max (integer) --
The maximum number of protections that can be created for the specified Type .
ProactiveEngagementStatus (string) --
If ENABLED , the DDoS Response Team (DRT) will use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.
If PENDING , you have requested proactive engagement and the request is pending. The status changes to ENABLED when your request is fully processed.
If DISABLED , the DRT will not proactively notify contacts about escalations or to initiate proactive customer support.
{'EmergencyContactList': {'ContactNotes': 'string', 'PhoneNumber': 'string'}}
Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
See also: AWS API Documentation
Request Syntax
client.update_emergency_contact_settings(
EmergencyContactList=[
{
'EmailAddress': 'string',
'PhoneNumber': 'string',
'ContactNotes': 'string'
},
]
)
list
A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.
If you have proactive engagement enabled, the contact list must include at least one phone number.
(dict) --
Contact information that the DRT can use to contact you if you have proactive engagement enabled, for escalations to the DRT 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.
dict
Response Syntax
{}
Response Structure
(dict) --