Skip to content

Type definitions#

Index > Shield > Type definitions

Auto-generated documentation for Shield type annotations stubs module mypy-boto3-shield.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ResponseActionUnionTypeDef#

# ResponseActionUnionTypeDef definition

ResponseActionUnionTypeDef = Union[
    ResponseActionTypeDef,  # (1)
    ResponseActionExtraOutputTypeDef,  # (2)
]
  1. See ResponseActionTypeDef
  2. See ResponseActionExtraOutputTypeDef

TimeRangeUnionTypeDef#

# TimeRangeUnionTypeDef definition

TimeRangeUnionTypeDef = Union[
    TimeRangeTypeDef,  # (1)
    TimeRangeOutputTypeDef,  # (2)
]
  1. See TimeRangeTypeDef
  2. See TimeRangeOutputTypeDef

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],
  1. See ProtectionGroupAggregationType
  2. See ProtectionGroupPatternType
  3. See ProtectedResourceTypeType

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)
  1. See ProtectedResourceTypeType

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)
  1. See ProtectionGroupPatternType
  2. See ProtectedResourceTypeType
  3. See ProtectionGroupAggregationType

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,

ResponseActionExtraOutputTypeDef#

# ResponseActionExtraOutputTypeDef definition

class ResponseActionExtraOutputTypeDef(TypedDict):
    Block: NotRequired[Dict[str, Any]],
    Count: NotRequired[Dict[str, Any]],

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]],
  1. See ProtectionGroupAggregationType
  2. See ProtectionGroupPatternType
  3. See ProtectedResourceTypeType

UpdateSubscriptionRequestRequestTypeDef#

# UpdateSubscriptionRequestRequestTypeDef definition

class UpdateSubscriptionRequestRequestTypeDef(TypedDict):
    AutoRenew: NotRequired[AutoRenewType],  # (1)
  1. See AutoRenewType

ApplicationLayerAutomaticResponseConfigurationTypeDef#

# ApplicationLayerAutomaticResponseConfigurationTypeDef definition

class ApplicationLayerAutomaticResponseConfigurationTypeDef(TypedDict):
    Status: ApplicationLayerAutomaticResponseStatusType,  # (1)
    Action: ResponseActionOutputTypeDef,  # (2)
  1. See ApplicationLayerAutomaticResponseStatusType
  2. See ResponseActionOutputTypeDef

AssociateProactiveEngagementDetailsRequestRequestTypeDef#

# AssociateProactiveEngagementDetailsRequestRequestTypeDef definition

class AssociateProactiveEngagementDetailsRequestRequestTypeDef(TypedDict):
    EmergencyContactList: Sequence[EmergencyContactTypeDef],  # (1)
  1. See EmergencyContactTypeDef

UpdateEmergencyContactSettingsRequestRequestTypeDef#

# UpdateEmergencyContactSettingsRequestRequestTypeDef definition

class UpdateEmergencyContactSettingsRequestRequestTypeDef(TypedDict):
    EmergencyContactList: NotRequired[Sequence[EmergencyContactTypeDef]],  # (1)
  1. See EmergencyContactTypeDef

SummarizedAttackVectorTypeDef#

# SummarizedAttackVectorTypeDef definition

class SummarizedAttackVectorTypeDef(TypedDict):
    VectorType: str,
    VectorCounters: NotRequired[List[SummarizedCounterTypeDef]],  # (1)
  1. See SummarizedCounterTypeDef

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],
  1. See AttackLayerType
  2. See AttackPropertyIdentifierType
  3. See ContributorTypeDef
  4. 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)
  1. See AttackVectorDescriptionTypeDef

AttackVolumeTypeDef#

# AttackVolumeTypeDef definition

class AttackVolumeTypeDef(TypedDict):
    BitsPerSecond: NotRequired[AttackVolumeStatisticsTypeDef],  # (1)
    PacketsPerSecond: NotRequired[AttackVolumeStatisticsTypeDef],  # (1)
    RequestsPerSecond: NotRequired[AttackVolumeStatisticsTypeDef],  # (1)
  1. See AttackVolumeStatisticsTypeDef
  2. See AttackVolumeStatisticsTypeDef
  3. 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)
  1. See ProtectionGroupAggregationType
  2. See ProtectionGroupPatternType
  3. See ProtectedResourceTypeType
  4. See TagTypeDef

CreateProtectionRequestRequestTypeDef#

# CreateProtectionRequestRequestTypeDef definition

class CreateProtectionRequestRequestTypeDef(TypedDict):
    Name: str,
    ResourceArn: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateProtectionResponseTypeDef#

# CreateProtectionResponseTypeDef definition

class CreateProtectionResponseTypeDef(TypedDict):
    ProtectionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeDRTAccessResponseTypeDef#

# DescribeDRTAccessResponseTypeDef definition

class DescribeDRTAccessResponseTypeDef(TypedDict):
    RoleArn: str,
    LogBucketList: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeEmergencyContactSettingsResponseTypeDef#

# DescribeEmergencyContactSettingsResponseTypeDef definition

class DescribeEmergencyContactSettingsResponseTypeDef(TypedDict):
    EmergencyContactList: List[EmergencyContactTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EmergencyContactTypeDef
  2. See ResponseMetadataTypeDef

GetSubscriptionStateResponseTypeDef#

# GetSubscriptionStateResponseTypeDef definition

class GetSubscriptionStateResponseTypeDef(TypedDict):
    SubscriptionState: SubscriptionStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionStateType
  2. See ResponseMetadataTypeDef

ListResourcesInProtectionGroupResponseTypeDef#

# ListResourcesInProtectionGroupResponseTypeDef definition

class ListResourcesInProtectionGroupResponseTypeDef(TypedDict):
    ResourceArns: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
    NextToken: NotRequired[str],
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef