Table of Contents
Shield.Client¶A low-level client representing AWS Shield
This is the Shield Advanced API Reference . This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide .
import boto3
client = boto3.client('shield')
These are the available methods:
associate_drt_log_bucket()associate_drt_role()associate_health_check()associate_proactive_engagement_details()can_paginate()close()create_protection()create_protection_group()create_subscription()delete_protection()delete_protection_group()delete_subscription()describe_attack()describe_attack_statistics()describe_drt_access()describe_emergency_contact_settings()describe_protection()describe_protection_group()describe_subscription()disable_application_layer_automatic_response()disable_proactive_engagement()disassociate_drt_log_bucket()disassociate_drt_role()disassociate_health_check()enable_application_layer_automatic_response()enable_proactive_engagement()get_paginator()get_subscription_state()get_waiter()list_attacks()list_protection_groups()list_protections()list_resources_in_protection_group()list_tags_for_resource()tag_resource()untag_resource()update_application_layer_automatic_response()update_emergency_contact_settings()update_protection_group()update_subscription()associate_drt_log_bucket(**kwargs)¶Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan .
See also: AWS API Documentation
Request Syntax
response = client.associate_drt_log_bucket(
LogBucket='string'
)
[REQUIRED]
The Amazon S3 bucket that contains the logs that you want to share.
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidOperationExceptionShield.Client.exceptions.NoAssociatedRoleExceptionShield.Client.exceptions.LimitsExceededExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.AccessDeniedForDependencyExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.ResourceNotFoundExceptionassociate_drt_role(**kwargs)¶Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn .
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the request. You can access this policy in the IAM console at AWSShieldDRTAccessPolicy . For more information see Adding and removing IAM identity permissions . The role must also trust the service principal drt.shield.amazonaws.com . For more information, see IAM JSON policy elements: Principal .
The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a user permissions to pass a role to an Amazon Web Services service .
To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan .
See also: AWS API Documentation
Request Syntax
response = client.associate_drt_role(
RoleArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the role the SRT will use to access your Amazon Web Services account.
Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see `Attaching and Detaching IAM Policies < https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_manage-attach-detach.html>`__ .
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidOperationExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.AccessDeniedForDependencyExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.ResourceNotFoundExceptionassociate_health_check(**kwargs)¶Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.associate_health_check(
ProtectionId='string',
HealthCheckArn='string'
)
[REQUIRED]
The unique identifier (ID) for the Protection object to add the health check association to.
[REQUIRED]
The Amazon Resource Name (ARN) of the health check to associate with the protection.
dict
Response Syntax
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.LimitsExceededExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.InvalidResourceExceptionassociate_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.
See also: AWS API Documentation
Request Syntax
response = client.associate_proactive_engagement_details(
EmergencyContactList=[
{
'EmailAddress': 'string',
'PhoneNumber': 'string',
'ContactNotes': 'string'
},
]
)
[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.
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.
The email address for the contact.
The phone number for the contact.
Additional notes regarding the contact.
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidOperationExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.OptimisticLockExceptioncan_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
create_protection(**kwargs)¶Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each CreateProtection request. You can add protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/ . For more information see Getting Started with Shield Advanced and Adding Shield Advanced protection to Amazon Web Services resources .
See also: AWS API Documentation
Request Syntax
response = client.create_protection(
Name='string',
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
Friendly name for the Protection you are creating.
[REQUIRED]
The ARN (Amazon Resource Name) of the resource to be protected.
The ARN should be in one of the following formats:
One or more tag key-value pairs for the Protection object that is created.
A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'ProtectionId': 'string'
}
Response Structure
(dict) --
ProtectionId (string) --
The unique identifier (ID) for the Protection object that is created.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidResourceExceptionShield.Client.exceptions.InvalidOperationExceptionShield.Client.exceptions.LimitsExceededExceptionShield.Client.exceptions.ResourceAlreadyExistsExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidParameterExceptioncreate_protection_group(**kwargs)¶Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
See also: AWS API Documentation
Request Syntax
response = client.create_protection_group(
ProtectionGroupId='string',
Aggregation='SUM'|'MEAN'|'MAX',
Pattern='ALL'|'ARBITRARY'|'BY_RESOURCE_TYPE',
ResourceType='CLOUDFRONT_DISTRIBUTION'|'ROUTE_53_HOSTED_ZONE'|'ELASTIC_IP_ALLOCATION'|'CLASSIC_LOAD_BALANCER'|'APPLICATION_LOAD_BALANCER'|'GLOBAL_ACCELERATOR',
Members=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
[REQUIRED]
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
[REQUIRED]
The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
One or more tag key-value pairs for the protection group.
A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceAlreadyExistsExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.LimitsExceededExceptioncreate_subscription()¶Activates Shield Advanced for an account.
Note
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.
See also: AWS API Documentation
Request Syntax
response = client.create_subscription()
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceAlreadyExistsExceptiondelete_protection(**kwargs)¶Deletes an Shield Advanced Protection .
See also: AWS API Documentation
Request Syntax
response = client.delete_protection(
ProtectionId='string'
)
[REQUIRED]
The unique identifier (ID) for the Protection object to be deleted.
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.OptimisticLockExceptiondelete_protection_group(**kwargs)¶Removes the specified protection group.
See also: AWS API Documentation
Request Syntax
response = client.delete_protection_group(
ProtectionGroupId='string'
)
[REQUIRED]
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.ResourceNotFoundExceptiondelete_subscription()¶Removes Shield Advanced from an account. Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.
Danger
This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.
See also: AWS API Documentation
Request Syntax
response = client.delete_subscription()
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.LockedSubscriptionExceptionShield.Client.exceptions.ResourceNotFoundExceptiondescribe_attack(**kwargs)¶Describes the details of a DDoS attack.
See also: AWS API Documentation
Request Syntax
response = client.describe_attack(
AttackId='string'
)
[REQUIRED]
The unique identifier (ID) for the attack.
{
'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'
},
],
'AttackProperties': [
{
'AttackLayer': 'NETWORK'|'APPLICATION',
'AttackPropertyIdentifier': 'DESTINATION_URL'|'REFERRER'|'SOURCE_ASN'|'SOURCE_COUNTRY'|'SOURCE_IP_ADDRESS'|'SOURCE_USER_AGENT'|'WORDPRESS_PINGBACK_REFLECTOR'|'WORDPRESS_PINGBACK_SOURCE',
'TopContributors': [
{
'Name': 'string',
'Value': 123
},
],
'Unit': 'BITS'|'BYTES'|'PACKETS'|'REQUESTS',
'Total': 123
},
],
'Mitigations': [
{
'MitigationName': 'string'
},
]
}
}
Response Structure
The attack that you requested.
The unique identifier (ID) of the attack.
The ARN (Amazon Resource Name) of the resource that was attacked.
If applicable, additional detail about the resource being attacked, for example, IP address or URL.
The attack information for the specified SubResource.
The SubResource type.
The unique identifier (ID) of the SubResource .
The list of attack types and associated counters.
A summary of information about the attack.
The attack type, for example, SNMP reflection or SYN flood.
The list of counters that describe the details of the attack.
The counter that describes a DDoS attack.
The counter name.
The maximum value of the counter for a specified time period.
The average value of the counter for a specified time period.
The total of counter values for a specified time period.
The number of counters for a specified time period.
The unit of the counters.
The counters that describe the details of the attack.
The counter that describes a DDoS attack.
The counter name.
The maximum value of the counter for a specified time period.
The average value of the counter for a specified time period.
The total of counter values for a specified time period.
The number of counters for a specified time period.
The unit of the counters.
The time the attack started, in Unix time in seconds.
The time the attack ended, in Unix time in seconds.
List of counters that describe the attack for the specified time period.
The counter that describes a DDoS attack.
The counter name.
The maximum value of the counter for a specified time period.
The average value of the counter for a specified time period.
The total of counter values for a specified time period.
The number of counters for a specified time period.
The unit of the counters.
The array of objects that provide details of the Shield event.
For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide .
Details of a Shield event. This is provided as part of an AttackDetail .
The type of Shield event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.
For infrastructure layer events (L3 and L4 events), you can view metrics for top contributors in Amazon CloudWatch metrics. For more information, see Shield metrics and alarms in the WAF Developer Guide .
Defines the Shield event property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback events.
Contributor objects for the top five contributors to a Shield event. A contributor is a source of traffic that Shield Advanced identifies as responsible for some or all of an event.
A contributor to the attack and their contribution.
The name of the contributor. The type of name that you'll find here depends on the AttackPropertyIdentifier setting in the AttackProperty where this contributor is defined. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY , the Name could be United States .
The contribution of this contributor expressed in Protection units. For example 10,000 .
The unit used for the Contributor Value property.
The total contributions made to this Shield event by all contributors.
List of mitigation actions taken for the attack.
The mitigation applied to a DDoS attack.
The name of the mitigation taken for this attack.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.AccessDeniedExceptiondescribe_attack_statistics()¶Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example, if the current time is 2020-10-26 15:39:32 PDT , equal to 2020-10-26 22:39:32 UTC , then the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to 2020-10-26 00:00:00 UTC .
The time range indicates the period covered by the attack statistics data items.
See also: AWS API Documentation
Request Syntax
response = client.describe_attack_statistics()
{
'TimeRange': {
'FromInclusive': datetime(2015, 1, 1),
'ToExclusive': datetime(2015, 1, 1)
},
'DataItems': [
{
'AttackVolume': {
'BitsPerSecond': {
'Max': 123.0
},
'PacketsPerSecond': {
'Max': 123.0
},
'RequestsPerSecond': {
'Max': 123.0
}
},
'AttackCount': 123
},
]
}
Response Structure
The time range of the attack.
The start time, in Unix time in seconds.
The end time, in Unix time in seconds.
The data that describes the attacks detected during the time period.
A single attack statistics data record. This is returned by DescribeAttackStatistics along with a time range indicating the time period that the attack statistics apply to.
Information about the volume of attacks during the time period. If the accompanying AttackCount is zero, this setting might be empty.
A statistics object that uses bits per second as the unit. This is included for network level attacks.
The maximum attack volume observed for the given unit.
A statistics object that uses packets per second as the unit. This is included for network level attacks.
The maximum attack volume observed for the given unit.
A statistics object that uses requests per second as the unit. This is included for application level attacks, and is only available for accounts that are subscribed to Shield Advanced.
The maximum attack volume observed for the given unit.
The number of attacks detected during the time period. This is always present, but might be zero.
Exceptions
Shield.Client.exceptions.InternalErrorExceptiondescribe_drt_access()¶Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
See also: AWS API Documentation
Request Syntax
response = client.describe_drt_access()
{
'RoleArn': 'string',
'LogBucketList': [
'string',
]
}
Response Structure
The Amazon Resource Name (ARN) of the role the SRT used to access your Amazon Web Services account.
The list of Amazon S3 buckets accessed by the SRT.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptiondescribe_emergency_contact_settings()¶A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
See also: AWS API Documentation
Request Syntax
response = client.describe_emergency_contact_settings()
{
'EmergencyContactList': [
{
'EmailAddress': 'string',
'PhoneNumber': 'string',
'ContactNotes': 'string'
},
]
}
Response Structure
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
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.
The email address for the contact.
The phone number for the contact.
Additional notes regarding the contact.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptiondescribe_protection(**kwargs)¶Lists the details of a Protection object.
See also: AWS API Documentation
Request Syntax
response = client.describe_protection(
ProtectionId='string',
ResourceArn='string'
)
ResourceArn of the protected resource or the ProtectionID of the protection, but not both.ResourceArn of the protected resource or the ProtectionID of the protection, but not both.dict
Response Syntax
{
'Protection': {
'Id': 'string',
'Name': 'string',
'ResourceArn': 'string',
'HealthCheckIds': [
'string',
],
'ProtectionArn': 'string',
'ApplicationLayerAutomaticResponseConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'Action': {
'Block': {},
'Count': {}
}
}
}
}
Response Structure
(dict) --
Protection (dict) --
The Protection that you requested.
Id (string) --
The unique identifier (ID) of the protection.
Name (string) --
The name of the protection. For example, My CloudFront distributions .
ResourceArn (string) --
The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
HealthCheckIds (list) --
The unique identifier (ID) for the Route 53 health check that's associated with the protection.
ProtectionArn (string) --
The ARN (Amazon Resource Name) of the protection.
ApplicationLayerAutomaticResponseConfiguration (dict) --
The automatic application layer DDoS mitigation settings for the protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
Status (string) --
Indicates whether automatic application layer DDoS mitigation is enabled for the protection.
Action (dict) --
Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
Block (dict) --
Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
You must specify exactly one action, either Block or Count .
Count (dict) --
Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
You must specify exactly one action, either Block or Count .
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.ResourceNotFoundExceptiondescribe_protection_group(**kwargs)¶Returns the specification for the specified protection group.
See also: AWS API Documentation
Request Syntax
response = client.describe_protection_group(
ProtectionGroupId='string'
)
[REQUIRED]
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
{
'ProtectionGroup': {
'ProtectionGroupId': 'string',
'Aggregation': 'SUM'|'MEAN'|'MAX',
'Pattern': 'ALL'|'ARBITRARY'|'BY_RESOURCE_TYPE',
'ResourceType': 'CLOUDFRONT_DISTRIBUTION'|'ROUTE_53_HOSTED_ZONE'|'ELASTIC_IP_ALLOCATION'|'CLASSIC_LOAD_BALANCER'|'APPLICATION_LOAD_BALANCER'|'GLOBAL_ACCELERATOR',
'Members': [
'string',
],
'ProtectionGroupArn': 'string'
}
}
Response Structure
A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
The ARN (Amazon Resource Name) of the protection group.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptiondescribe_subscription()¶Provides details about the Shield Advanced subscription for an account.
See also: AWS API Documentation
Request Syntax
response = client.describe_subscription()
{
'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',
'SubscriptionLimits': {
'ProtectionLimits': {
'ProtectedResourceTypeLimits': [
{
'Type': 'string',
'Max': 123
},
]
},
'ProtectionGroupLimits': {
'MaxProtectionGroups': 123,
'PatternTypeLimits': {
'ArbitraryPatternLimits': {
'MaxMembers': 123
}
}
}
},
'SubscriptionArn': 'string'
}
}
Response Structure
The Shield Advanced subscription details for an account.
The start time of the subscription, in Unix time in seconds.
The date and time your subscription will end.
The length, in seconds, of the Shield Advanced subscription for the account.
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.
Specifies how many protections of a given type you can create.
Specifies how many protections of a given type you can create.
The type of protection.
The maximum number of protections that can be created for the specified Type .
If ENABLED , the Shield Response Team (SRT) will use email and phone to notify contacts about escalations to the SRT 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 SRT will not proactively notify contacts about escalations or to initiate proactive customer support.
Limits settings for your subscription.
Limits settings on protections for your subscription.
The maximum number of resource types that you can specify in a protection.
Specifies how many protections of a given type you can create.
The type of protection.
The maximum number of protections that can be created for the specified Type .
Limits settings on protection groups for your subscription.
The maximum number of protection groups that you can have at one time.
Limits settings by pattern type in the protection groups for your subscription.
Limits settings on protection groups with arbitrary pattern type.
The maximum number of resources you can specify for a single arbitrary pattern in a protection group.
The ARN (Amazon Resource Name) of the subscription.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptiondisable_application_layer_automatic_response(**kwargs)¶Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
See also: AWS API Documentation
Request Syntax
response = client.disable_application_layer_automatic_response(
ResourceArn='string'
)
[REQUIRED]
The ARN (Amazon Resource Name) of the protected resource.
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.InvalidOperationExceptiondisable_proactive_engagement()¶Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
See also: AWS API Documentation
Request Syntax
response = client.disable_proactive_engagement()
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidOperationExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.OptimisticLockExceptiondisassociate_drt_log_bucket(**kwargs)¶Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_drt_log_bucket(
LogBucket='string'
)
[REQUIRED]
The Amazon S3 bucket that contains the logs that you want to share.
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidOperationExceptionShield.Client.exceptions.NoAssociatedRoleExceptionShield.Client.exceptions.AccessDeniedForDependencyExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.ResourceNotFoundExceptiondisassociate_drt_role()¶Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.disassociate_drt_role()
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidOperationExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.ResourceNotFoundExceptiondisassociate_health_check(**kwargs)¶Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.disassociate_health_check(
ProtectionId='string',
HealthCheckArn='string'
)
[REQUIRED]
The unique identifier (ID) for the Protection object to remove the health check association from.
[REQUIRED]
The Amazon Resource Name (ARN) of the health check that is associated with the protection.
dict
Response Syntax
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.InvalidResourceExceptionenable_application_layer_automatic_response(**kwargs)¶Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
Note
This feature is available for Amazon CloudFront distributions and Application Load Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation .
Note
Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse .
To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/ . For more information, see Getting Started with Shield Advanced . You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.enable_application_layer_automatic_response(
ResourceArn='string',
Action={
'Block': {}
,
'Count': {}
}
)
[REQUIRED]
The ARN (Amazon Resource Name) of the protected resource.
[REQUIRED]
Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
You must specify exactly one action, either Block or Count .
Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
You must specify exactly one action, either Block or Count .
dict
Response Syntax
{}
Response Structure
Exceptions
Shield.Client.exceptions.LimitsExceededExceptionShield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.InvalidOperationExceptionenable_proactive_engagement()¶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.
See also: AWS API Documentation
Request Syntax
response = client.enable_proactive_engagement()
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidOperationExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.OptimisticLockExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_subscription_state()¶Returns the SubscriptionState , either Active or Inactive .
See also: AWS API Documentation
Request Syntax
response = client.get_subscription_state()
{
'SubscriptionState': 'ACTIVE'|'INACTIVE'
}
Response Structure
The status of the subscription.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_attacks(**kwargs)¶Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
See also: AWS API Documentation
Request Syntax
response = 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
)
The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.
The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.
The start time, in Unix time in seconds.
The end time, in Unix time in seconds.
The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.
The start time, in Unix time in seconds.
The end time, in Unix time in seconds.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
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 Unix time in seconds.
EndTime (datetime) --
The end time of the attack, in Unix time in seconds.
AttackVectors (list) --
The list of attacks for a specified time period.
(dict) --
Describes the attack.
VectorType (string) --
The attack type. Valid values:
NextToken (string) --
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.InvalidOperationExceptionlist_protection_groups(**kwargs)¶Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
See also: AWS API Documentation
Request Syntax
response = client.list_protection_groups(
NextToken='string',
MaxResults=123,
InclusionFilters={
'ProtectionGroupIds': [
'string',
],
'Patterns': [
'ALL'|'ARBITRARY'|'BY_RESOURCE_TYPE',
],
'ResourceTypes': [
'CLOUDFRONT_DISTRIBUTION'|'ROUTE_53_HOSTED_ZONE'|'ELASTIC_IP_ALLOCATION'|'CLASSIC_LOAD_BALANCER'|'APPLICATION_LOAD_BALANCER'|'GLOBAL_ACCELERATOR',
],
'Aggregations': [
'SUM'|'MEAN'|'MAX',
]
}
)
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its name and you can retrieve all protection groups that are configured with specific pattern or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that exactly match all of the search criteria that you provide.
The ID of the protection group that you want to retrieve.
The pattern specification of the protection groups that you want to retrieve.
The resource type configuration of the protection groups that you want to retrieve. In the protection group configuration, you specify the resource type when you set the group's Pattern to BY_RESOURCE_TYPE .
The aggregation setting of the protection groups that you want to retrieve.
dict
Response Syntax
{
'ProtectionGroups': [
{
'ProtectionGroupId': 'string',
'Aggregation': 'SUM'|'MEAN'|'MAX',
'Pattern': 'ALL'|'ARBITRARY'|'BY_RESOURCE_TYPE',
'ResourceType': 'CLOUDFRONT_DISTRIBUTION'|'ROUTE_53_HOSTED_ZONE'|'ELASTIC_IP_ALLOCATION'|'CLASSIC_LOAD_BALANCER'|'APPLICATION_LOAD_BALANCER'|'GLOBAL_ACCELERATOR',
'Members': [
'string',
],
'ProtectionGroupArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ProtectionGroups (list) --
(dict) --
A grouping of protected resources that you and Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
ProtectionGroupId (string) --
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
Aggregation (string) --
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
Pattern (string) --
The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.
ResourceType (string) --
The resource type to include in the protection group. All protected resources of this type are included in the protection group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.
Members (list) --
The ARNs (Amazon Resource Names) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
ProtectionGroupArn (string) --
The ARN (Amazon Resource Name) of the protection group.
NextToken (string) --
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidPaginationTokenExceptionlist_protections(**kwargs)¶Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
See also: AWS API Documentation
Request Syntax
response = client.list_protections(
NextToken='string',
MaxResults=123,
InclusionFilters={
'ResourceArns': [
'string',
],
'ProtectionNames': [
'string',
],
'ResourceTypes': [
'CLOUDFRONT_DISTRIBUTION'|'ROUTE_53_HOSTED_ZONE'|'ELASTIC_IP_ALLOCATION'|'CLASSIC_LOAD_BALANCER'|'APPLICATION_LOAD_BALANCER'|'GLOBAL_ACCELERATOR',
]
}
)
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.
The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve.
The name of the protection that you want to retrieve.
The type of protected resource whose protections you want to retrieve.
dict
Response Syntax
{
'Protections': [
{
'Id': 'string',
'Name': 'string',
'ResourceArn': 'string',
'HealthCheckIds': [
'string',
],
'ProtectionArn': 'string',
'ApplicationLayerAutomaticResponseConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'Action': {
'Block': {},
'Count': {}
}
}
},
],
'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 name of the protection. For example, My CloudFront distributions .
ResourceArn (string) --
The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
HealthCheckIds (list) --
The unique identifier (ID) for the Route 53 health check that's associated with the protection.
ProtectionArn (string) --
The ARN (Amazon Resource Name) of the protection.
ApplicationLayerAutomaticResponseConfiguration (dict) --
The automatic application layer DDoS mitigation settings for the protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
Status (string) --
Indicates whether automatic application layer DDoS mitigation is enabled for the protection.
Action (dict) --
Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
Block (dict) --
Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
You must specify exactly one action, either Block or Count .
Count (dict) --
Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
You must specify exactly one action, either Block or Count .
NextToken (string) --
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidPaginationTokenExceptionlist_resources_in_protection_group(**kwargs)¶Retrieves the resources that are included in the protection group.
See also: AWS API Documentation
Request Syntax
response = client.list_resources_in_protection_group(
ProtectionGroupId='string',
NextToken='string',
MaxResults=123
)
[REQUIRED]
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
On your first call to a list operation, leave this setting empty.
The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might return fewer objects than you indicate in this setting, even if more objects are available. If there are more objects remaining, Shield Advanced will always also return a NextToken value in the response.
The default setting is 20.
dict
Response Syntax
{
'ResourceArns': [
'string',
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceArns (list) --
The Amazon Resource Names (ARNs) of the resources that are included in the protection group.
NextToken (string) --
When you request a list of objects from Shield Advanced, if the response does not include all of the remaining available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the next batch of objects by requesting the list again and providing the token that was returned by the prior call in your request.
You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the MaxResults setting. Shield Advanced will not return more than MaxResults objects, but may return fewer, even if more objects are still available.
Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a NextToken value.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidPaginationTokenExceptionGets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to get tags for.
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
A list of tag key and value pairs associated with the specified resource.
A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidResourceExceptionShield.Client.exceptions.ResourceNotFoundExceptiontag_resource(**kwargs)¶Adds or updates tags for a resource in Shield.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.
[REQUIRED]
The tags that you want to modify or add to the resource.
A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidResourceExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Removes tags from a resource in Shield.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
[REQUIRED]
The tag key for each tag that you want to remove from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidResourceExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.ResourceNotFoundExceptionupdate_application_layer_automatic_response(**kwargs)¶Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.update_application_layer_automatic_response(
ResourceArn='string',
Action={
'Block': {}
,
'Count': {}
}
)
[REQUIRED]
The ARN (Amazon Resource Name) of the resource.
[REQUIRED]
Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
You must specify exactly one action, either Block or Count .
Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
You must specify exactly one action, either Block or Count .
dict
Response Syntax
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.InvalidOperationExceptionupdate_emergency_contact_settings(**kwargs)¶Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
See also: AWS API Documentation
Request Syntax
response = client.update_emergency_contact_settings(
EmergencyContactList=[
{
'EmailAddress': 'string',
'PhoneNumber': 'string',
'ContactNotes': 'string'
},
]
)
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
If you have proactive engagement enabled, the contact list must include at least one phone number.
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.
The email address for the contact.
The phone number for the contact.
Additional notes regarding the contact.
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.ResourceNotFoundExceptionupdate_protection_group(**kwargs)¶Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
See also: AWS API Documentation
Request Syntax
response = client.update_protection_group(
ProtectionGroupId='string',
Aggregation='SUM'|'MEAN'|'MAX',
Pattern='ALL'|'ARBITRARY'|'BY_RESOURCE_TYPE',
ResourceType='CLOUDFRONT_DISTRIBUTION'|'ROUTE_53_HOSTED_ZONE'|'ELASTIC_IP_ALLOCATION'|'CLASSIC_LOAD_BALANCER'|'APPLICATION_LOAD_BALANCER'|'GLOBAL_ACCELERATOR',
Members=[
'string',
]
)
[REQUIRED]
The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.
[REQUIRED]
Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.
[REQUIRED]
The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.
Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.
dict
Response Syntax
{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.OptimisticLockExceptionShield.Client.exceptions.InvalidParameterExceptionupdate_subscription(**kwargs)¶Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
Note
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
See also: AWS API Documentation
Request Syntax
response = client.update_subscription(
AutoRenew='ENABLED'|'DISABLED'
)
AutoRenew is set to ENABLED . If ENABLED , the subscription will be automatically renewed at the end of the existing subscription period. 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.{}
Response Structure
Exceptions
Shield.Client.exceptions.InternalErrorExceptionShield.Client.exceptions.LockedSubscriptionExceptionShield.Client.exceptions.ResourceNotFoundExceptionShield.Client.exceptions.InvalidParameterExceptionShield.Client.exceptions.OptimisticLockExceptionThe available paginators are:
Shield.Paginator.ListAttacks¶paginator = client.get_paginator('list_attacks')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Shield.Client.list_attacks().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceArns=[
'string',
],
StartTime={
'FromInclusive': datetime(2015, 1, 1),
'ToExclusive': datetime(2015, 1, 1)
},
EndTime={
'FromInclusive': datetime(2015, 1, 1),
'ToExclusive': datetime(2015, 1, 1)
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The ARNs (Amazon Resource Names) of the resources that were attacked. If you leave this blank, all applicable resources for this account will be included.
The start of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.
The start time, in Unix time in seconds.
The end time, in Unix time in seconds.
The end of the time period for the attacks. This is a timestamp type. The request syntax listing for this call indicates a number type, but you can provide the time in any valid timestamp format setting.
The start time, in Unix time in seconds.
The end time, in Unix time in seconds.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AttackSummaries': [
{
'AttackId': 'string',
'ResourceArn': 'string',
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1),
'AttackVectors': [
{
'VectorType': '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 Unix time in seconds.
EndTime (datetime) --
The end time of the attack, in Unix time in seconds.
AttackVectors (list) --
The list of attacks for a specified time period.
(dict) --
Describes the attack.
VectorType (string) --
The attack type. Valid values:
Shield.Paginator.ListProtections¶paginator = client.get_paginator('list_protections')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from Shield.Client.list_protections().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
InclusionFilters={
'ResourceArns': [
'string',
],
'ProtectionNames': [
'string',
],
'ResourceTypes': [
'CLOUDFRONT_DISTRIBUTION'|'ROUTE_53_HOSTED_ZONE'|'ELASTIC_IP_ALLOCATION'|'CLASSIC_LOAD_BALANCER'|'APPLICATION_LOAD_BALANCER'|'GLOBAL_ACCELERATOR',
]
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Narrows the set of protections that the call retrieves. You can retrieve a single protection by providing its name or the ARN (Amazon Resource Name) of its protected resource. You can also retrieve all protections for a specific resource type. You can provide up to one criteria per filter type. Shield Advanced returns protections that exactly match all of the filter criteria that you provide.
The ARN (Amazon Resource Name) of the resource whose protection you want to retrieve.
The name of the protection that you want to retrieve.
The type of protected resource whose protections you want to retrieve.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Protections': [
{
'Id': 'string',
'Name': 'string',
'ResourceArn': 'string',
'HealthCheckIds': [
'string',
],
'ProtectionArn': 'string',
'ApplicationLayerAutomaticResponseConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'Action': {
'Block': {},
'Count': {}
}
}
},
],
}
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 name of the protection. For example, My CloudFront distributions .
ResourceArn (string) --
The ARN (Amazon Resource Name) of the Amazon Web Services resource that is protected.
HealthCheckIds (list) --
The unique identifier (ID) for the Route 53 health check that's associated with the protection.
ProtectionArn (string) --
The ARN (Amazon Resource Name) of the protection.
ApplicationLayerAutomaticResponseConfiguration (dict) --
The automatic application layer DDoS mitigation settings for the protection. This configuration determines whether Shield Advanced automatically manages rules in the web ACL in order to respond to application layer events that Shield Advanced determines to be DDoS attacks.
Status (string) --
Indicates whether automatic application layer DDoS mitigation is enabled for the protection.
Action (dict) --
Specifies the action setting that Shield Advanced should use in the WAF rules that it creates on behalf of the protected resource in response to DDoS attacks. You specify this as part of the configuration for the automatic application layer DDoS mitigation feature, when you enable or update automatic mitigation. Shield Advanced creates the WAF rules in a Shield Advanced-managed rule group, inside the web ACL that you have associated with the resource.
Block (dict) --
Specifies that Shield Advanced should configure its WAF rules with the WAF Block action.
You must specify exactly one action, either Block or Count .
Count (dict) --
Specifies that Shield Advanced should configure its WAF rules with the WAF Count action.
You must specify exactly one action, either Block or Count .