2016/12/01 - AWS Shield - 9 new api methods
Changes Update shield client to latest version
Activates AWS Shield Advanced for an account.
See also: AWS API Documentation
Request Syntax
client.create_subscription()
dict
Response Syntax
{}
Response Structure
(dict) --
Lists all Protection objects for the account.
See also: AWS API Documentation
Request Syntax
client.list_protections(
NextToken='string',
MaxResults=123
)
string
The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.
integer
The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned.
dict
Response Syntax
{
'Protections': [
{
'Id': 'string',
'Name': 'string',
'ResourceArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Protections (list) --
The array of enabled Protection objects.
(dict) --
An object that represents a resource that is under DDoS protection.
Id (string) --
The unique identifier (ID) of the protection.
Name (string) --
The friendly name of the protection. For example, My CloudFront distributions.
ResourceArn (string) --
The ARN (Amazon Resource Name) of the AWS resource that is protected.
NextToken (string) --
If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.
Describes the details of a DDoS attack.
See also: AWS API Documentation
Request Syntax
client.describe_attack(
AttackId='string'
)
string
[REQUIRED]
The unique identifier (ID) for the attack that to be described.
dict
Response Syntax
{
'Attack': {
'AttackId': 'string',
'ResourceArn': 'string',
'SubResources': [
{
'Type': 'IP'|'URL',
'Id': 'string',
'AttackVectors': [
{
'VectorType': 'string',
'VectorCounters': [
{
'Name': 'string',
'Max': 123.0,
'Average': 123.0,
'Sum': 123.0,
'N': 123,
'Unit': 'string'
},
]
},
],
'Counters': [
{
'Name': 'string',
'Max': 123.0,
'Average': 123.0,
'Sum': 123.0,
'N': 123,
'Unit': 'string'
},
]
},
],
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'AttackCounters': [
{
'Name': 'string',
'Max': 123.0,
'Average': 123.0,
'Sum': 123.0,
'N': 123,
'Unit': 'string'
},
],
'Mitigations': [
{
'MitigationName': 'string'
},
]
}
}
Response Structure
(dict) --
Attack (dict) --
The attack that is described.
AttackId (string) --
The unique identifier (ID) of the attack.
ResourceArn (string) --
The ARN (Amazon Resource Name) of the resource that was attacked.
SubResources (list) --
If applicable, additional detail about the resource being attacked, for example, IP address or URL.
(dict) --
The attack information for the specified SubResource.
Type (string) --
The SubResource type.
Id (string) --
The unique identifier (ID) of the SubResource.
AttackVectors (list) --
The list of attack types and associated counters.
(dict) --
A summary of information about the attack.
VectorType (string) --
The attack type, for example, SNMP reflection or SYN flood.
VectorCounters (list) --
The list of counters that describe the details of the attack.
(dict) --
The counter that describes a DDoS attack.
Name (string) --
The counter name.
Max (float) --
The maximum value of the counter for a specified time period.
Average (float) --
The average value of the counter for a specified time period.
Sum (float) --
The total of counter values for a specified time period.
N (integer) --
The number of counters for a specified time period.
Unit (string) --
The unit of the counters.
Counters (list) --
The counters that describe the details of the attack.
(dict) --
The counter that describes a DDoS attack.
Name (string) --
The counter name.
Max (float) --
The maximum value of the counter for a specified time period.
Average (float) --
The average value of the counter for a specified time period.
Sum (float) --
The total of counter values for a specified time period.
N (integer) --
The number of counters for a specified time period.
Unit (string) --
The unit of the counters.
StartTime (datetime) --
The time the attack started, in the format 2016-12-16T13:50Z.
EndTime (datetime) --
The time the attack ended, in the format 2016-12-16T13:50Z.
AttackCounters (list) --
List of counters that describe the attack for the specified time period.
(dict) --
The counter that describes a DDoS attack.
Name (string) --
The counter name.
Max (float) --
The maximum value of the counter for a specified time period.
Average (float) --
The average value of the counter for a specified time period.
Sum (float) --
The total of counter values for a specified time period.
N (integer) --
The number of counters for a specified time period.
Unit (string) --
The unit of the counters.
Mitigations (list) --
List of mitigation actions taken for the attack.
(dict) --
The mitigation applied to a DDoS attack.
MitigationName (string) --
The name of the mitigation taken for this attack.
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),
'TimeCommitmentInSeconds': 123
}
}
Response Structure
(dict) --
Subscription (dict) --
The AWS Shield Advanced subscription details for an account.
StartTime (datetime) --
The start time of the subscription, in the format "2016-12-16T13:50Z".
TimeCommitmentInSeconds (integer) --
The length, in seconds, of the AWS Shield Advanced subscription for the account.
Lists the details of a Protection object.
See also: AWS API Documentation
Request Syntax
client.describe_protection(
ProtectionId='string'
)
string
[REQUIRED]
The unique identifier (ID) for the Protection object that is described.
dict
Response Syntax
{
'Protection': {
'Id': 'string',
'Name': 'string',
'ResourceArn': 'string'
}
}
Response Structure
(dict) --
Protection (dict) --
The Protection object that is described.
Id (string) --
The unique identifier (ID) of the protection.
Name (string) --
The friendly name of the protection. For example, My CloudFront distributions.
ResourceArn (string) --
The ARN (Amazon Resource Name) of the AWS resource that is protected.
Removes AWS Shield Advanced from an account.
See also: AWS API Documentation
Request Syntax
client.delete_subscription()
dict
Response Syntax
{}
Response Structure
(dict) --
Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, or an Amazon Route 53 hosted zone.
See also: AWS API Documentation
Request Syntax
client.create_protection(
Name='string',
ResourceArn='string'
)
string
[REQUIRED]
Friendly name for the Protection you are creating.
string
[REQUIRED]
The ARN (Amazon Resource Name) of the resource to be protected.
dict
Response Syntax
{
'ProtectionId': 'string'
}
Response Structure
(dict) --
ProtectionId (string) --
The unique identifier (ID) for the Protection object that is created.
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
See also: AWS API Documentation
Request Syntax
client.list_attacks(
ResourceArns=[
'string',
],
StartTime={
'FromInclusive': datetime(2015, 1, 1),
'ToExclusive': datetime(2015, 1, 1)
},
EndTime={
'FromInclusive': datetime(2015, 1, 1),
'ToExclusive': datetime(2015, 1, 1)
},
NextToken='string',
MaxResults=123
)
list
The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.
(string) --
dict
The time period for the attacks.
FromInclusive (datetime) --
The start time, in the format 2016-12-16T13:50Z.
ToExclusive (datetime) --
The end time, in the format 2016-12-16T15:50Z.
dict
The end of the time period for the attacks.
FromInclusive (datetime) --
The start time, in the format 2016-12-16T13:50Z.
ToExclusive (datetime) --
The end time, in the format 2016-12-16T15:50Z.
string
The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.
integer
The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned.
dict
Response Syntax
{
'AttackSummaries': [
{
'AttackId': 'string',
'ResourceArn': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'AttackVectors': [
{
'VectorType': 'string'
},
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AttackSummaries (list) --
The attack information for the specified time range.
(dict) --
Summarizes all DDoS attacks for a specified time period.
AttackId (string) --
The unique identifier (ID) of the attack.
ResourceArn (string) --
The ARN (Amazon Resource Name) of the resource that was attacked.
StartTime (datetime) --
The start time of the attack, in the format 2016-12-16T13:50Z.
EndTime (datetime) --
The end time of the attack, in the format 2016-12-16T13:50Z.
AttackVectors (list) --
The list of attacks for a specified time period.
(dict) --
Describes the attack.
VectorType (string) --
The attack type, for example, SNMP reflection or SYN flood.
NextToken (string) --
The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items.
Deletes an AWS Shield Advanced Protection.
See also: AWS API Documentation
Request Syntax
client.delete_protection(
ProtectionId='string'
)
string
[REQUIRED]
The unique identifier (ID) for the Protection object to be deleted.
dict
Response Syntax
{}
Response Structure
(dict) --