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