ShieldClient#
Auto-generated documentation for Shield type annotations stubs module mypy-boto3-shield.
ShieldClient#
Type annotations and code completion for boto3.client("shield").
boto3 documentation
# ShieldClient usage example
from boto3.session import Session
from mypy_boto3_shield.client import ShieldClient
def get_shield_client() -> ShieldClient:
return Session().client("shield")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("shield").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("shield")
try:
do_something(client)
except (
client.exceptions.AccessDeniedException,
client.exceptions.AccessDeniedForDependencyException,
client.exceptions.ClientError,
client.exceptions.InternalErrorException,
client.exceptions.InvalidOperationException,
client.exceptions.InvalidPaginationTokenException,
client.exceptions.InvalidParameterException,
client.exceptions.InvalidResourceException,
client.exceptions.LimitsExceededException,
client.exceptions.LockedSubscriptionException,
client.exceptions.NoAssociatedRoleException,
client.exceptions.OptimisticLockException,
client.exceptions.ResourceAlreadyExistsException,
client.exceptions.ResourceNotFoundException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_shield.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...Methods#
can_paginate#
Type annotations and code completion for boto3.client("shield").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...generate_presigned_url#
Type annotations and code completion for boto3.client("shield").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...associate_drt_log_bucket#
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.
Type annotations and code completion for boto3.client("shield").associate_drt_log_bucket method.
boto3 documentation
# associate_drt_log_bucket method definition
def associate_drt_log_bucket(
self,
*,
LogBucket: str,
) -> dict[str, Any]:
...# associate_drt_log_bucket method usage example with argument unpacking
kwargs: AssociateDRTLogBucketRequestRequestTypeDef = { # (1)
"LogBucket": ...,
}
parent.associate_drt_log_bucket(**kwargs)associate_drt_role#
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.
Type annotations and code completion for boto3.client("shield").associate_drt_role method.
boto3 documentation
# associate_drt_role method definition
def associate_drt_role(
self,
*,
RoleArn: str,
) -> dict[str, Any]:
...# associate_drt_role method usage example with argument unpacking
kwargs: AssociateDRTRoleRequestRequestTypeDef = { # (1)
"RoleArn": ...,
}
parent.associate_drt_role(**kwargs)associate_health_check#
Adds health-based detection to the Shield Advanced protection for a resource.
Type annotations and code completion for boto3.client("shield").associate_health_check method.
boto3 documentation
# associate_health_check method definition
def associate_health_check(
self,
*,
ProtectionId: str,
HealthCheckArn: str,
) -> dict[str, Any]:
...# associate_health_check method usage example with argument unpacking
kwargs: AssociateHealthCheckRequestRequestTypeDef = { # (1)
"ProtectionId": ...,
"HealthCheckArn": ...,
}
parent.associate_health_check(**kwargs)associate_proactive_engagement_details#
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.
Type annotations and code completion for boto3.client("shield").associate_proactive_engagement_details method.
boto3 documentation
# associate_proactive_engagement_details method definition
def associate_proactive_engagement_details(
self,
*,
EmergencyContactList: Sequence[EmergencyContactTypeDef], # (1)
) -> dict[str, Any]:
...# associate_proactive_engagement_details method usage example with argument unpacking
kwargs: AssociateProactiveEngagementDetailsRequestRequestTypeDef = { # (1)
"EmergencyContactList": ...,
}
parent.associate_proactive_engagement_details(**kwargs)create_protection#
Enables Shield Advanced for a specific Amazon Web Services resource.
Type annotations and code completion for boto3.client("shield").create_protection method.
boto3 documentation
# create_protection method definition
def create_protection(
self,
*,
Name: str,
ResourceArn: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> CreateProtectionResponseTypeDef: # (2)
...# create_protection method usage example with argument unpacking
kwargs: CreateProtectionRequestRequestTypeDef = { # (1)
"Name": ...,
"ResourceArn": ...,
}
parent.create_protection(**kwargs)create_protection_group#
Creates a grouping of protected resources so they can be handled as a collective.
Type annotations and code completion for boto3.client("shield").create_protection_group method.
boto3 documentation
# create_protection_group method definition
def create_protection_group(
self,
*,
ProtectionGroupId: str,
Aggregation: ProtectionGroupAggregationType, # (1)
Pattern: ProtectionGroupPatternType, # (2)
ResourceType: ProtectedResourceTypeType = ..., # (3)
Members: Sequence[str] = ...,
Tags: Sequence[TagTypeDef] = ..., # (4)
) -> dict[str, Any]:
...- See ProtectionGroupAggregationType
- See ProtectionGroupPatternType
- See ProtectedResourceTypeType
- See TagTypeDef
# create_protection_group method usage example with argument unpacking
kwargs: CreateProtectionGroupRequestRequestTypeDef = { # (1)
"ProtectionGroupId": ...,
"Aggregation": ...,
"Pattern": ...,
}
parent.create_protection_group(**kwargs)create_subscription#
Activates Shield Advanced for an account.
Type annotations and code completion for boto3.client("shield").create_subscription method.
boto3 documentation
# create_subscription method definition
def create_subscription(
self,
) -> dict[str, Any]:
...delete_protection#
Deletes an Shield Advanced Protection.
Type annotations and code completion for boto3.client("shield").delete_protection method.
boto3 documentation
# delete_protection method definition
def delete_protection(
self,
*,
ProtectionId: str,
) -> dict[str, Any]:
...# delete_protection method usage example with argument unpacking
kwargs: DeleteProtectionRequestRequestTypeDef = { # (1)
"ProtectionId": ...,
}
parent.delete_protection(**kwargs)delete_protection_group#
Removes the specified protection group.
Type annotations and code completion for boto3.client("shield").delete_protection_group method.
boto3 documentation
# delete_protection_group method definition
def delete_protection_group(
self,
*,
ProtectionGroupId: str,
) -> dict[str, Any]:
...# delete_protection_group method usage example with argument unpacking
kwargs: DeleteProtectionGroupRequestRequestTypeDef = { # (1)
"ProtectionGroupId": ...,
}
parent.delete_protection_group(**kwargs)delete_subscription#
Removes Shield Advanced from an account.
Type annotations and code completion for boto3.client("shield").delete_subscription method.
boto3 documentation
# delete_subscription method definition
def delete_subscription(
self,
) -> dict[str, Any]:
...describe_attack#
Describes the details of a DDoS attack.
Type annotations and code completion for boto3.client("shield").describe_attack method.
boto3 documentation
# describe_attack method definition
def describe_attack(
self,
*,
AttackId: str,
) -> DescribeAttackResponseTypeDef: # (1)
...# describe_attack method usage example with argument unpacking
kwargs: DescribeAttackRequestRequestTypeDef = { # (1)
"AttackId": ...,
}
parent.describe_attack(**kwargs)describe_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.
Type annotations and code completion for boto3.client("shield").describe_attack_statistics method.
boto3 documentation
# describe_attack_statistics method definition
def describe_attack_statistics(
self,
) -> DescribeAttackStatisticsResponseTypeDef: # (1)
...describe_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.
Type annotations and code completion for boto3.client("shield").describe_drt_access method.
boto3 documentation
# describe_drt_access method definition
def describe_drt_access(
self,
) -> DescribeDRTAccessResponseTypeDef: # (1)
...describe_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.
Type annotations and code completion for boto3.client("shield").describe_emergency_contact_settings method.
boto3 documentation
# describe_emergency_contact_settings method definition
def describe_emergency_contact_settings(
self,
) -> DescribeEmergencyContactSettingsResponseTypeDef: # (1)
...describe_protection#
Lists the details of a Protection object.
Type annotations and code completion for boto3.client("shield").describe_protection method.
boto3 documentation
# describe_protection method definition
def describe_protection(
self,
*,
ProtectionId: str = ...,
ResourceArn: str = ...,
) -> DescribeProtectionResponseTypeDef: # (1)
...# describe_protection method usage example with argument unpacking
kwargs: DescribeProtectionRequestRequestTypeDef = { # (1)
"ProtectionId": ...,
}
parent.describe_protection(**kwargs)describe_protection_group#
Returns the specification for the specified protection group.
Type annotations and code completion for boto3.client("shield").describe_protection_group method.
boto3 documentation
# describe_protection_group method definition
def describe_protection_group(
self,
*,
ProtectionGroupId: str,
) -> DescribeProtectionGroupResponseTypeDef: # (1)
...# describe_protection_group method usage example with argument unpacking
kwargs: DescribeProtectionGroupRequestRequestTypeDef = { # (1)
"ProtectionGroupId": ...,
}
parent.describe_protection_group(**kwargs)describe_subscription#
Provides details about the Shield Advanced subscription for an account.
Type annotations and code completion for boto3.client("shield").describe_subscription method.
boto3 documentation
# describe_subscription method definition
def describe_subscription(
self,
) -> DescribeSubscriptionResponseTypeDef: # (1)
...disable_application_layer_automatic_response#
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.
Type annotations and code completion for boto3.client("shield").disable_application_layer_automatic_response method.
boto3 documentation
# disable_application_layer_automatic_response method definition
def disable_application_layer_automatic_response(
self,
*,
ResourceArn: str,
) -> dict[str, Any]:
...# disable_application_layer_automatic_response method usage example with argument unpacking
kwargs: DisableApplicationLayerAutomaticResponseRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.disable_application_layer_automatic_response(**kwargs)disable_proactive_engagement#
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
Type annotations and code completion for boto3.client("shield").disable_proactive_engagement method.
boto3 documentation
# disable_proactive_engagement method definition
def disable_proactive_engagement(
self,
) -> dict[str, Any]:
...disassociate_drt_log_bucket#
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
Type annotations and code completion for boto3.client("shield").disassociate_drt_log_bucket method.
boto3 documentation
# disassociate_drt_log_bucket method definition
def disassociate_drt_log_bucket(
self,
*,
LogBucket: str,
) -> dict[str, Any]:
...# disassociate_drt_log_bucket method usage example with argument unpacking
kwargs: DisassociateDRTLogBucketRequestRequestTypeDef = { # (1)
"LogBucket": ...,
}
parent.disassociate_drt_log_bucket(**kwargs)disassociate_drt_role#
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
Type annotations and code completion for boto3.client("shield").disassociate_drt_role method.
boto3 documentation
# disassociate_drt_role method definition
def disassociate_drt_role(
self,
) -> dict[str, Any]:
...disassociate_health_check#
Removes health-based detection from the Shield Advanced protection for a resource.
Type annotations and code completion for boto3.client("shield").disassociate_health_check method.
boto3 documentation
# disassociate_health_check method definition
def disassociate_health_check(
self,
*,
ProtectionId: str,
HealthCheckArn: str,
) -> dict[str, Any]:
...# disassociate_health_check method usage example with argument unpacking
kwargs: DisassociateHealthCheckRequestRequestTypeDef = { # (1)
"ProtectionId": ...,
"HealthCheckArn": ...,
}
parent.disassociate_health_check(**kwargs)enable_application_layer_automatic_response#
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
Type annotations and code completion for boto3.client("shield").enable_application_layer_automatic_response method.
boto3 documentation
# enable_application_layer_automatic_response method definition
def enable_application_layer_automatic_response(
self,
*,
ResourceArn: str,
Action: ResponseActionTypeDef, # (1)
) -> dict[str, Any]:
...# enable_application_layer_automatic_response method usage example with argument unpacking
kwargs: EnableApplicationLayerAutomaticResponseRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Action": ...,
}
parent.enable_application_layer_automatic_response(**kwargs)enable_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.
Type annotations and code completion for boto3.client("shield").enable_proactive_engagement method.
boto3 documentation
# enable_proactive_engagement method definition
def enable_proactive_engagement(
self,
) -> dict[str, Any]:
...get_subscription_state#
Returns the SubscriptionState, either Active or
Inactive.
Type annotations and code completion for boto3.client("shield").get_subscription_state method.
boto3 documentation
# get_subscription_state method definition
def get_subscription_state(
self,
) -> GetSubscriptionStateResponseTypeDef: # (1)
...list_attacks#
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
Type annotations and code completion for boto3.client("shield").list_attacks method.
boto3 documentation
# list_attacks method definition
def list_attacks(
self,
*,
ResourceArns: Sequence[str] = ...,
StartTime: TimeRangeTypeDef = ..., # (1)
EndTime: TimeRangeTypeDef = ..., # (1)
NextToken: str = ...,
MaxResults: int = ...,
) -> ListAttacksResponseTypeDef: # (3)
...# list_attacks method usage example with argument unpacking
kwargs: ListAttacksRequestRequestTypeDef = { # (1)
"ResourceArns": ...,
}
parent.list_attacks(**kwargs)list_protection_groups#
Retrieves ProtectionGroup objects for the account.
Type annotations and code completion for boto3.client("shield").list_protection_groups method.
boto3 documentation
# list_protection_groups method definition
def list_protection_groups(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
InclusionFilters: InclusionProtectionGroupFiltersTypeDef = ..., # (1)
) -> ListProtectionGroupsResponseTypeDef: # (2)
...# list_protection_groups method usage example with argument unpacking
kwargs: ListProtectionGroupsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_protection_groups(**kwargs)list_protections#
Retrieves Protection objects for the account.
Type annotations and code completion for boto3.client("shield").list_protections method.
boto3 documentation
# list_protections method definition
def list_protections(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
InclusionFilters: InclusionProtectionFiltersTypeDef = ..., # (1)
) -> ListProtectionsResponseTypeDef: # (2)
...# list_protections method usage example with argument unpacking
kwargs: ListProtectionsRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_protections(**kwargs)list_resources_in_protection_group#
Retrieves the resources that are included in the protection group.
Type annotations and code completion for boto3.client("shield").list_resources_in_protection_group method.
boto3 documentation
# list_resources_in_protection_group method definition
def list_resources_in_protection_group(
self,
*,
ProtectionGroupId: str,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListResourcesInProtectionGroupResponseTypeDef: # (1)
...# list_resources_in_protection_group method usage example with argument unpacking
kwargs: ListResourcesInProtectionGroupRequestRequestTypeDef = { # (1)
"ProtectionGroupId": ...,
}
parent.list_resources_in_protection_group(**kwargs)list_tags_for_resource#
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
Type annotations and code completion for boto3.client("shield").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceARN: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
}
parent.list_tags_for_resource(**kwargs)tag_resource#
Adds or updates tags for a resource in Shield.
Type annotations and code completion for boto3.client("shield").tag_resource method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
) -> dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes tags from a resource in Shield.
Type annotations and code completion for boto3.client("shield").untag_resource method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
ResourceARN: str,
TagKeys: Sequence[str],
) -> dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceARN": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)update_application_layer_automatic_response#
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
Type annotations and code completion for boto3.client("shield").update_application_layer_automatic_response method.
boto3 documentation
# update_application_layer_automatic_response method definition
def update_application_layer_automatic_response(
self,
*,
ResourceArn: str,
Action: ResponseActionTypeDef, # (1)
) -> dict[str, Any]:
...# update_application_layer_automatic_response method usage example with argument unpacking
kwargs: UpdateApplicationLayerAutomaticResponseRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Action": ...,
}
parent.update_application_layer_automatic_response(**kwargs)update_emergency_contact_settings#
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.
Type annotations and code completion for boto3.client("shield").update_emergency_contact_settings method.
boto3 documentation
# update_emergency_contact_settings method definition
def update_emergency_contact_settings(
self,
*,
EmergencyContactList: Sequence[EmergencyContactTypeDef] = ..., # (1)
) -> dict[str, Any]:
...# update_emergency_contact_settings method usage example with argument unpacking
kwargs: UpdateEmergencyContactSettingsRequestRequestTypeDef = { # (1)
"EmergencyContactList": ...,
}
parent.update_emergency_contact_settings(**kwargs)update_protection_group#
Updates an existing protection group.
Type annotations and code completion for boto3.client("shield").update_protection_group method.
boto3 documentation
# update_protection_group method definition
def update_protection_group(
self,
*,
ProtectionGroupId: str,
Aggregation: ProtectionGroupAggregationType, # (1)
Pattern: ProtectionGroupPatternType, # (2)
ResourceType: ProtectedResourceTypeType = ..., # (3)
Members: Sequence[str] = ...,
) -> dict[str, Any]:
...# update_protection_group method usage example with argument unpacking
kwargs: UpdateProtectionGroupRequestRequestTypeDef = { # (1)
"ProtectionGroupId": ...,
"Aggregation": ...,
"Pattern": ...,
}
parent.update_protection_group(**kwargs)update_subscription#
Updates the details of an existing subscription.
Type annotations and code completion for boto3.client("shield").update_subscription method.
boto3 documentation
# update_subscription method definition
def update_subscription(
self,
*,
AutoRenew: AutoRenewType = ..., # (1)
) -> dict[str, Any]:
...- See AutoRenewType
# update_subscription method usage example with argument unpacking
kwargs: UpdateSubscriptionRequestRequestTypeDef = { # (1)
"AutoRenew": ...,
}
parent.update_subscription(**kwargs)get_paginator#
Type annotations and code completion for boto3.client("shield").get_paginator method with overloads.
client.get_paginator("list_attacks")-> ListAttacksPaginatorclient.get_paginator("list_protections")-> ListProtectionsPaginator