Type definitions#
Auto-generated documentation for Shield type annotations stubs module mypy-boto3-shield.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
ResponseActionOutputTypeDef#
# ResponseActionOutputTypeDef definition
class ResponseActionOutputTypeDef(TypedDict):
Block: NotRequired[Dict[str, Any]],
Count: NotRequired[Dict[str, Any]],
AssociateDRTLogBucketRequestRequestTypeDef#
# AssociateDRTLogBucketRequestRequestTypeDef definition
class AssociateDRTLogBucketRequestRequestTypeDef(TypedDict):
LogBucket: str,
AssociateDRTRoleRequestRequestTypeDef#
# AssociateDRTRoleRequestRequestTypeDef definition
class AssociateDRTRoleRequestRequestTypeDef(TypedDict):
RoleArn: str,
AssociateHealthCheckRequestRequestTypeDef#
# AssociateHealthCheckRequestRequestTypeDef definition
class AssociateHealthCheckRequestRequestTypeDef(TypedDict):
ProtectionId: str,
HealthCheckArn: str,
EmergencyContactTypeDef#
# EmergencyContactTypeDef definition
class EmergencyContactTypeDef(TypedDict):
EmailAddress: str,
PhoneNumber: NotRequired[str],
ContactNotes: NotRequired[str],
MitigationTypeDef#
# MitigationTypeDef definition
class MitigationTypeDef(TypedDict):
MitigationName: NotRequired[str],
SummarizedCounterTypeDef#
# SummarizedCounterTypeDef definition
class SummarizedCounterTypeDef(TypedDict):
Name: NotRequired[str],
Max: NotRequired[float],
Average: NotRequired[float],
Sum: NotRequired[float],
N: NotRequired[int],
Unit: NotRequired[str],
ContributorTypeDef#
# ContributorTypeDef definition
class ContributorTypeDef(TypedDict):
Name: NotRequired[str],
Value: NotRequired[int],
AttackVectorDescriptionTypeDef#
# AttackVectorDescriptionTypeDef definition
class AttackVectorDescriptionTypeDef(TypedDict):
VectorType: str,
AttackVolumeStatisticsTypeDef#
# AttackVolumeStatisticsTypeDef definition
class AttackVolumeStatisticsTypeDef(TypedDict):
Max: float,
TagTypeDef#
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: NotRequired[str],
Value: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
DeleteProtectionGroupRequestRequestTypeDef#
# DeleteProtectionGroupRequestRequestTypeDef definition
class DeleteProtectionGroupRequestRequestTypeDef(TypedDict):
ProtectionGroupId: str,
DeleteProtectionRequestRequestTypeDef#
# DeleteProtectionRequestRequestTypeDef definition
class DeleteProtectionRequestRequestTypeDef(TypedDict):
ProtectionId: str,
DescribeAttackRequestRequestTypeDef#
# DescribeAttackRequestRequestTypeDef definition
class DescribeAttackRequestRequestTypeDef(TypedDict):
AttackId: str,
TimeRangeOutputTypeDef#
# TimeRangeOutputTypeDef definition
class TimeRangeOutputTypeDef(TypedDict):
FromInclusive: NotRequired[datetime],
ToExclusive: NotRequired[datetime],
DescribeProtectionGroupRequestRequestTypeDef#
# DescribeProtectionGroupRequestRequestTypeDef definition
class DescribeProtectionGroupRequestRequestTypeDef(TypedDict):
ProtectionGroupId: str,
ProtectionGroupTypeDef#
# ProtectionGroupTypeDef definition
class ProtectionGroupTypeDef(TypedDict):
ProtectionGroupId: str,
Aggregation: ProtectionGroupAggregationType, # (1)
Pattern: ProtectionGroupPatternType, # (2)
Members: List[str],
ResourceType: NotRequired[ProtectedResourceTypeType], # (3)
ProtectionGroupArn: NotRequired[str],
DescribeProtectionRequestRequestTypeDef#
# DescribeProtectionRequestRequestTypeDef definition
class DescribeProtectionRequestRequestTypeDef(TypedDict):
ProtectionId: NotRequired[str],
ResourceArn: NotRequired[str],
DisableApplicationLayerAutomaticResponseRequestRequestTypeDef#
# DisableApplicationLayerAutomaticResponseRequestRequestTypeDef definition
class DisableApplicationLayerAutomaticResponseRequestRequestTypeDef(TypedDict):
ResourceArn: str,
DisassociateDRTLogBucketRequestRequestTypeDef#
# DisassociateDRTLogBucketRequestRequestTypeDef definition
class DisassociateDRTLogBucketRequestRequestTypeDef(TypedDict):
LogBucket: str,
DisassociateHealthCheckRequestRequestTypeDef#
# DisassociateHealthCheckRequestRequestTypeDef definition
class DisassociateHealthCheckRequestRequestTypeDef(TypedDict):
ProtectionId: str,
HealthCheckArn: str,
ResponseActionTypeDef#
# ResponseActionTypeDef definition
class ResponseActionTypeDef(TypedDict):
Block: NotRequired[Mapping[str, Any]],
Count: NotRequired[Mapping[str, Any]],
InclusionProtectionFiltersTypeDef#
# InclusionProtectionFiltersTypeDef definition
class InclusionProtectionFiltersTypeDef(TypedDict):
ResourceArns: NotRequired[Sequence[str]],
ProtectionNames: NotRequired[Sequence[str]],
ResourceTypes: NotRequired[Sequence[ProtectedResourceTypeType]], # (1)
InclusionProtectionGroupFiltersTypeDef#
# InclusionProtectionGroupFiltersTypeDef definition
class InclusionProtectionGroupFiltersTypeDef(TypedDict):
ProtectionGroupIds: NotRequired[Sequence[str]],
Patterns: NotRequired[Sequence[ProtectionGroupPatternType]], # (1)
ResourceTypes: NotRequired[Sequence[ProtectedResourceTypeType]], # (2)
Aggregations: NotRequired[Sequence[ProtectionGroupAggregationType]], # (3)
LimitTypeDef#
# LimitTypeDef definition
class LimitTypeDef(TypedDict):
Type: NotRequired[str],
Max: NotRequired[int],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListResourcesInProtectionGroupRequestRequestTypeDef#
# ListResourcesInProtectionGroupRequestRequestTypeDef definition
class ListResourcesInProtectionGroupRequestRequestTypeDef(TypedDict):
ProtectionGroupId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
ProtectionGroupArbitraryPatternLimitsTypeDef#
# ProtectionGroupArbitraryPatternLimitsTypeDef definition
class ProtectionGroupArbitraryPatternLimitsTypeDef(TypedDict):
MaxMembers: int,
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
UpdateProtectionGroupRequestRequestTypeDef#
# UpdateProtectionGroupRequestRequestTypeDef definition
class UpdateProtectionGroupRequestRequestTypeDef(TypedDict):
ProtectionGroupId: str,
Aggregation: ProtectionGroupAggregationType, # (1)
Pattern: ProtectionGroupPatternType, # (2)
ResourceType: NotRequired[ProtectedResourceTypeType], # (3)
Members: NotRequired[Sequence[str]],
UpdateSubscriptionRequestRequestTypeDef#
# UpdateSubscriptionRequestRequestTypeDef definition
class UpdateSubscriptionRequestRequestTypeDef(TypedDict):
AutoRenew: NotRequired[AutoRenewType], # (1)
- See AutoRenewType
ApplicationLayerAutomaticResponseConfigurationTypeDef#
# ApplicationLayerAutomaticResponseConfigurationTypeDef definition
class ApplicationLayerAutomaticResponseConfigurationTypeDef(TypedDict):
Status: ApplicationLayerAutomaticResponseStatusType, # (1)
Action: ResponseActionOutputTypeDef, # (2)
AssociateProactiveEngagementDetailsRequestRequestTypeDef#
# AssociateProactiveEngagementDetailsRequestRequestTypeDef definition
class AssociateProactiveEngagementDetailsRequestRequestTypeDef(TypedDict):
EmergencyContactList: Sequence[EmergencyContactTypeDef], # (1)
UpdateEmergencyContactSettingsRequestRequestTypeDef#
# UpdateEmergencyContactSettingsRequestRequestTypeDef definition
class UpdateEmergencyContactSettingsRequestRequestTypeDef(TypedDict):
EmergencyContactList: NotRequired[Sequence[EmergencyContactTypeDef]], # (1)
SummarizedAttackVectorTypeDef#
# SummarizedAttackVectorTypeDef definition
class SummarizedAttackVectorTypeDef(TypedDict):
VectorType: str,
VectorCounters: NotRequired[List[SummarizedCounterTypeDef]], # (1)
AttackPropertyTypeDef#
# AttackPropertyTypeDef definition
class AttackPropertyTypeDef(TypedDict):
AttackLayer: NotRequired[AttackLayerType], # (1)
AttackPropertyIdentifier: NotRequired[AttackPropertyIdentifierType], # (2)
TopContributors: NotRequired[List[ContributorTypeDef]], # (3)
Unit: NotRequired[UnitType], # (4)
Total: NotRequired[int],
- See AttackLayerType
- See AttackPropertyIdentifierType
- See ContributorTypeDef
- See UnitType
AttackSummaryTypeDef#
# AttackSummaryTypeDef definition
class AttackSummaryTypeDef(TypedDict):
AttackId: NotRequired[str],
ResourceArn: NotRequired[str],
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
AttackVectors: NotRequired[List[AttackVectorDescriptionTypeDef]], # (1)
AttackVolumeTypeDef#
# AttackVolumeTypeDef definition
class AttackVolumeTypeDef(TypedDict):
BitsPerSecond: NotRequired[AttackVolumeStatisticsTypeDef], # (1)
PacketsPerSecond: NotRequired[AttackVolumeStatisticsTypeDef], # (1)
RequestsPerSecond: NotRequired[AttackVolumeStatisticsTypeDef], # (1)
- See AttackVolumeStatisticsTypeDef
- See AttackVolumeStatisticsTypeDef
- See AttackVolumeStatisticsTypeDef
CreateProtectionGroupRequestRequestTypeDef#
# CreateProtectionGroupRequestRequestTypeDef definition
class CreateProtectionGroupRequestRequestTypeDef(TypedDict):
ProtectionGroupId: str,
Aggregation: ProtectionGroupAggregationType, # (1)
Pattern: ProtectionGroupPatternType, # (2)
ResourceType: NotRequired[ProtectedResourceTypeType], # (3)
Members: NotRequired[Sequence[str]],
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
- See ProtectionGroupAggregationType
- See ProtectionGroupPatternType
- See ProtectedResourceTypeType
- See TagTypeDef
CreateProtectionRequestRequestTypeDef#
# CreateProtectionRequestRequestTypeDef definition
class CreateProtectionRequestRequestTypeDef(TypedDict):
Name: str,
ResourceArn: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateProtectionResponseTypeDef#
# CreateProtectionResponseTypeDef definition
class CreateProtectionResponseTypeDef(TypedDict):
ProtectionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeDRTAccessResponseTypeDef#
# DescribeDRTAccessResponseTypeDef definition
class DescribeDRTAccessResponseTypeDef(TypedDict):
RoleArn: str,
LogBucketList: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeEmergencyContactSettingsResponseTypeDef#
# DescribeEmergencyContactSettingsResponseTypeDef definition
class DescribeEmergencyContactSettingsResponseTypeDef(TypedDict):
EmergencyContactList: List[EmergencyContactTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSubscriptionStateResponseTypeDef#
# GetSubscriptionStateResponseTypeDef definition
class GetSubscriptionStateResponseTypeDef(TypedDict):
SubscriptionState: SubscriptionStateType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListResourcesInProtectionGroupResponseTypeDef#
# ListResourcesInProtectionGroupResponseTypeDef definition
class ListResourcesInProtectionGroupResponseTypeDef(TypedDict):
ResourceArns: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
NextToken: NotRequired[str],
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
DescribeProtectionGroupResponseTypeDef#
# DescribeProtectionGroupResponseTypeDef definition
class DescribeProtectionGroupResponseTypeDef(TypedDict):
ProtectionGroup: ProtectionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListProtectionGroupsResponseTypeDef#
# ListProtectionGroupsResponseTypeDef definition
class ListProtectionGroupsResponseTypeDef(TypedDict):
ProtectionGroups: List[ProtectionGroupTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
EnableApplicationLayerAutomaticResponseRequestRequestTypeDef#
# EnableApplicationLayerAutomaticResponseRequestRequestTypeDef definition
class EnableApplicationLayerAutomaticResponseRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Action: ResponseActionTypeDef, # (1)
UpdateApplicationLayerAutomaticResponseRequestRequestTypeDef#
# UpdateApplicationLayerAutomaticResponseRequestRequestTypeDef definition
class UpdateApplicationLayerAutomaticResponseRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Action: ResponseActionTypeDef, # (1)
ListProtectionsRequestRequestTypeDef#
# ListProtectionsRequestRequestTypeDef definition
class ListProtectionsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
InclusionFilters: NotRequired[InclusionProtectionFiltersTypeDef], # (1)
ListProtectionGroupsRequestRequestTypeDef#
# ListProtectionGroupsRequestRequestTypeDef definition
class ListProtectionGroupsRequestRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
InclusionFilters: NotRequired[InclusionProtectionGroupFiltersTypeDef], # (1)
ProtectionLimitsTypeDef#
# ProtectionLimitsTypeDef definition
class ProtectionLimitsTypeDef(TypedDict):
ProtectedResourceTypeLimits: List[LimitTypeDef], # (1)
- See LimitTypeDef
ListProtectionsRequestListProtectionsPaginateTypeDef#
# ListProtectionsRequestListProtectionsPaginateTypeDef definition
class ListProtectionsRequestListProtectionsPaginateTypeDef(TypedDict):
InclusionFilters: NotRequired[InclusionProtectionFiltersTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ProtectionGroupPatternTypeLimitsTypeDef#
# ProtectionGroupPatternTypeLimitsTypeDef definition
class ProtectionGroupPatternTypeLimitsTypeDef(TypedDict):
ArbitraryPatternLimits: ProtectionGroupArbitraryPatternLimitsTypeDef, # (1)
TimeRangeTypeDef#
# TimeRangeTypeDef definition
class TimeRangeTypeDef(TypedDict):
FromInclusive: NotRequired[TimestampTypeDef],
ToExclusive: NotRequired[TimestampTypeDef],
ProtectionTypeDef#
# ProtectionTypeDef definition
class ProtectionTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
ResourceArn: NotRequired[str],
HealthCheckIds: NotRequired[List[str]],
ProtectionArn: NotRequired[str],
ApplicationLayerAutomaticResponseConfiguration: NotRequired[ApplicationLayerAutomaticResponseConfigurationTypeDef], # (1)
SubResourceSummaryTypeDef#
# SubResourceSummaryTypeDef definition
class SubResourceSummaryTypeDef(TypedDict):
Type: NotRequired[SubResourceTypeType], # (1)
Id: NotRequired[str],
AttackVectors: NotRequired[List[SummarizedAttackVectorTypeDef]], # (2)
Counters: NotRequired[List[SummarizedCounterTypeDef]], # (3)
ListAttacksResponseTypeDef#
# ListAttacksResponseTypeDef definition
class ListAttacksResponseTypeDef(TypedDict):
AttackSummaries: List[AttackSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
AttackStatisticsDataItemTypeDef#
# AttackStatisticsDataItemTypeDef definition
class AttackStatisticsDataItemTypeDef(TypedDict):
AttackCount: int,
AttackVolume: NotRequired[AttackVolumeTypeDef], # (1)
ProtectionGroupLimitsTypeDef#
# ProtectionGroupLimitsTypeDef definition
class ProtectionGroupLimitsTypeDef(TypedDict):
MaxProtectionGroups: int,
PatternTypeLimits: ProtectionGroupPatternTypeLimitsTypeDef, # (1)
ListAttacksRequestListAttacksPaginateTypeDef#
# ListAttacksRequestListAttacksPaginateTypeDef definition
class ListAttacksRequestListAttacksPaginateTypeDef(TypedDict):
ResourceArns: NotRequired[Sequence[str]],
StartTime: NotRequired[TimeRangeTypeDef], # (1)
EndTime: NotRequired[TimeRangeTypeDef], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)
- See TimeRangeTypeDef
- See TimeRangeTypeDef
- See PaginatorConfigTypeDef
ListAttacksRequestRequestTypeDef#
# ListAttacksRequestRequestTypeDef definition
class ListAttacksRequestRequestTypeDef(TypedDict):
ResourceArns: NotRequired[Sequence[str]],
StartTime: NotRequired[TimeRangeTypeDef], # (1)
EndTime: NotRequired[TimeRangeTypeDef], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See TimeRangeTypeDef
- See TimeRangeTypeDef
DescribeProtectionResponseTypeDef#
# DescribeProtectionResponseTypeDef definition
class DescribeProtectionResponseTypeDef(TypedDict):
Protection: ProtectionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListProtectionsResponseTypeDef#
# ListProtectionsResponseTypeDef definition
class ListProtectionsResponseTypeDef(TypedDict):
Protections: List[ProtectionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
AttackDetailTypeDef#
# AttackDetailTypeDef definition
class AttackDetailTypeDef(TypedDict):
AttackId: NotRequired[str],
ResourceArn: NotRequired[str],
SubResources: NotRequired[List[SubResourceSummaryTypeDef]], # (1)
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
AttackCounters: NotRequired[List[SummarizedCounterTypeDef]], # (2)
AttackProperties: NotRequired[List[AttackPropertyTypeDef]], # (3)
Mitigations: NotRequired[List[MitigationTypeDef]], # (4)
- See SubResourceSummaryTypeDef
- See SummarizedCounterTypeDef
- See AttackPropertyTypeDef
- See MitigationTypeDef
DescribeAttackStatisticsResponseTypeDef#
# DescribeAttackStatisticsResponseTypeDef definition
class DescribeAttackStatisticsResponseTypeDef(TypedDict):
TimeRange: TimeRangeOutputTypeDef, # (1)
DataItems: List[AttackStatisticsDataItemTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
SubscriptionLimitsTypeDef#
# SubscriptionLimitsTypeDef definition
class SubscriptionLimitsTypeDef(TypedDict):
ProtectionLimits: ProtectionLimitsTypeDef, # (1)
ProtectionGroupLimits: ProtectionGroupLimitsTypeDef, # (2)
DescribeAttackResponseTypeDef#
# DescribeAttackResponseTypeDef definition
class DescribeAttackResponseTypeDef(TypedDict):
Attack: AttackDetailTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SubscriptionTypeDef#
# SubscriptionTypeDef definition
class SubscriptionTypeDef(TypedDict):
SubscriptionLimits: SubscriptionLimitsTypeDef, # (4)
StartTime: NotRequired[datetime],
EndTime: NotRequired[datetime],
TimeCommitmentInSeconds: NotRequired[int],
AutoRenew: NotRequired[AutoRenewType], # (1)
Limits: NotRequired[List[LimitTypeDef]], # (2)
ProactiveEngagementStatus: NotRequired[ProactiveEngagementStatusType], # (3)
SubscriptionArn: NotRequired[str],
DescribeSubscriptionResponseTypeDef#
# DescribeSubscriptionResponseTypeDef definition
class DescribeSubscriptionResponseTypeDef(TypedDict):
Subscription: SubscriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)