Skip to content

Type definitions#

Index > Shield > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef Union usage example

from types_boto3_shield.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

ResponseActionUnionTypeDef#

# ResponseActionUnionTypeDef Union usage example

from types_boto3_shield.type_defs import ResponseActionUnionTypeDef


def get_value() -> ResponseActionUnionTypeDef:
    return ...


# ResponseActionUnionTypeDef definition

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

TimeRangeUnionTypeDef#

# TimeRangeUnionTypeDef Union usage example

from types_boto3_shield.type_defs import TimeRangeUnionTypeDef


def get_value() -> TimeRangeUnionTypeDef:
    return ...


# TimeRangeUnionTypeDef definition

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

ResponseActionOutputTypeDef#

# ResponseActionOutputTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ResponseActionOutputTypeDef


def get_value() -> ResponseActionOutputTypeDef:
    return {
        "Block": ...,
    }


# ResponseActionOutputTypeDef definition

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

AssociateDRTLogBucketRequestTypeDef#

# AssociateDRTLogBucketRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AssociateDRTLogBucketRequestTypeDef


def get_value() -> AssociateDRTLogBucketRequestTypeDef:
    return {
        "LogBucket": ...,
    }


# AssociateDRTLogBucketRequestTypeDef definition

class AssociateDRTLogBucketRequestTypeDef(TypedDict):
    LogBucket: str,

AssociateDRTRoleRequestTypeDef#

# AssociateDRTRoleRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AssociateDRTRoleRequestTypeDef


def get_value() -> AssociateDRTRoleRequestTypeDef:
    return {
        "RoleArn": ...,
    }


# AssociateDRTRoleRequestTypeDef definition

class AssociateDRTRoleRequestTypeDef(TypedDict):
    RoleArn: str,

AssociateHealthCheckRequestTypeDef#

# AssociateHealthCheckRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AssociateHealthCheckRequestTypeDef


def get_value() -> AssociateHealthCheckRequestTypeDef:
    return {
        "ProtectionId": ...,
    }


# AssociateHealthCheckRequestTypeDef definition

class AssociateHealthCheckRequestTypeDef(TypedDict):
    ProtectionId: str,
    HealthCheckArn: str,

EmergencyContactTypeDef#

# EmergencyContactTypeDef TypedDict usage example

from types_boto3_shield.type_defs import EmergencyContactTypeDef


def get_value() -> EmergencyContactTypeDef:
    return {
        "EmailAddress": ...,
    }


# EmergencyContactTypeDef definition

class EmergencyContactTypeDef(TypedDict):
    EmailAddress: str,
    PhoneNumber: NotRequired[str],
    ContactNotes: NotRequired[str],

MitigationTypeDef#

# MitigationTypeDef TypedDict usage example

from types_boto3_shield.type_defs import MitigationTypeDef


def get_value() -> MitigationTypeDef:
    return {
        "MitigationName": ...,
    }


# MitigationTypeDef definition

class MitigationTypeDef(TypedDict):
    MitigationName: NotRequired[str],

SummarizedCounterTypeDef#

# SummarizedCounterTypeDef TypedDict usage example

from types_boto3_shield.type_defs import SummarizedCounterTypeDef


def get_value() -> SummarizedCounterTypeDef:
    return {
        "Name": ...,
    }


# 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 TypedDict usage example

from types_boto3_shield.type_defs import ContributorTypeDef


def get_value() -> ContributorTypeDef:
    return {
        "Name": ...,
    }


# ContributorTypeDef definition

class ContributorTypeDef(TypedDict):
    Name: NotRequired[str],
    Value: NotRequired[int],

AttackVectorDescriptionTypeDef#

# AttackVectorDescriptionTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AttackVectorDescriptionTypeDef


def get_value() -> AttackVectorDescriptionTypeDef:
    return {
        "VectorType": ...,
    }


# AttackVectorDescriptionTypeDef definition

class AttackVectorDescriptionTypeDef(TypedDict):
    VectorType: str,

AttackVolumeStatisticsTypeDef#

# AttackVolumeStatisticsTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AttackVolumeStatisticsTypeDef


def get_value() -> AttackVolumeStatisticsTypeDef:
    return {
        "Max": ...,
    }


# AttackVolumeStatisticsTypeDef definition

class AttackVolumeStatisticsTypeDef(TypedDict):
    Max: float,

TagTypeDef#

# TagTypeDef TypedDict usage example

from types_boto3_shield.type_defs import TagTypeDef


def get_value() -> TagTypeDef:
    return {
        "Key": ...,
    }


# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: NotRequired[str],
    Value: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DeleteProtectionGroupRequestTypeDef#

# DeleteProtectionGroupRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DeleteProtectionGroupRequestTypeDef


def get_value() -> DeleteProtectionGroupRequestTypeDef:
    return {
        "ProtectionGroupId": ...,
    }


# DeleteProtectionGroupRequestTypeDef definition

class DeleteProtectionGroupRequestTypeDef(TypedDict):
    ProtectionGroupId: str,

DeleteProtectionRequestTypeDef#

# DeleteProtectionRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DeleteProtectionRequestTypeDef


def get_value() -> DeleteProtectionRequestTypeDef:
    return {
        "ProtectionId": ...,
    }


# DeleteProtectionRequestTypeDef definition

class DeleteProtectionRequestTypeDef(TypedDict):
    ProtectionId: str,

DescribeAttackRequestTypeDef#

# DescribeAttackRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeAttackRequestTypeDef


def get_value() -> DescribeAttackRequestTypeDef:
    return {
        "AttackId": ...,
    }


# DescribeAttackRequestTypeDef definition

class DescribeAttackRequestTypeDef(TypedDict):
    AttackId: str,

TimeRangeOutputTypeDef#

# TimeRangeOutputTypeDef TypedDict usage example

from types_boto3_shield.type_defs import TimeRangeOutputTypeDef


def get_value() -> TimeRangeOutputTypeDef:
    return {
        "FromInclusive": ...,
    }


# TimeRangeOutputTypeDef definition

class TimeRangeOutputTypeDef(TypedDict):
    FromInclusive: NotRequired[datetime.datetime],
    ToExclusive: NotRequired[datetime.datetime],

DescribeProtectionGroupRequestTypeDef#

# DescribeProtectionGroupRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeProtectionGroupRequestTypeDef


def get_value() -> DescribeProtectionGroupRequestTypeDef:
    return {
        "ProtectionGroupId": ...,
    }


# DescribeProtectionGroupRequestTypeDef definition

class DescribeProtectionGroupRequestTypeDef(TypedDict):
    ProtectionGroupId: str,

ProtectionGroupTypeDef#

# ProtectionGroupTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ProtectionGroupTypeDef


def get_value() -> ProtectionGroupTypeDef:
    return {
        "ProtectionGroupId": ...,
    }


# 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

DescribeProtectionRequestTypeDef#

# DescribeProtectionRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeProtectionRequestTypeDef


def get_value() -> DescribeProtectionRequestTypeDef:
    return {
        "ProtectionId": ...,
    }


# DescribeProtectionRequestTypeDef definition

class DescribeProtectionRequestTypeDef(TypedDict):
    ProtectionId: NotRequired[str],
    ResourceArn: NotRequired[str],

DisableApplicationLayerAutomaticResponseRequestTypeDef#

# DisableApplicationLayerAutomaticResponseRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DisableApplicationLayerAutomaticResponseRequestTypeDef


def get_value() -> DisableApplicationLayerAutomaticResponseRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# DisableApplicationLayerAutomaticResponseRequestTypeDef definition

class DisableApplicationLayerAutomaticResponseRequestTypeDef(TypedDict):
    ResourceArn: str,

DisassociateDRTLogBucketRequestTypeDef#

# DisassociateDRTLogBucketRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DisassociateDRTLogBucketRequestTypeDef


def get_value() -> DisassociateDRTLogBucketRequestTypeDef:
    return {
        "LogBucket": ...,
    }


# DisassociateDRTLogBucketRequestTypeDef definition

class DisassociateDRTLogBucketRequestTypeDef(TypedDict):
    LogBucket: str,

DisassociateHealthCheckRequestTypeDef#

# DisassociateHealthCheckRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DisassociateHealthCheckRequestTypeDef


def get_value() -> DisassociateHealthCheckRequestTypeDef:
    return {
        "ProtectionId": ...,
    }


# DisassociateHealthCheckRequestTypeDef definition

class DisassociateHealthCheckRequestTypeDef(TypedDict):
    ProtectionId: str,
    HealthCheckArn: str,

InclusionProtectionFiltersTypeDef#

# InclusionProtectionFiltersTypeDef TypedDict usage example

from types_boto3_shield.type_defs import InclusionProtectionFiltersTypeDef


def get_value() -> InclusionProtectionFiltersTypeDef:
    return {
        "ResourceArns": ...,
    }


# InclusionProtectionFiltersTypeDef definition

class InclusionProtectionFiltersTypeDef(TypedDict):
    ResourceArns: NotRequired[Sequence[str]],
    ProtectionNames: NotRequired[Sequence[str]],
    ResourceTypes: NotRequired[Sequence[ProtectedResourceTypeType]],  # (1)
  1. See Sequence[ProtectedResourceTypeType]

InclusionProtectionGroupFiltersTypeDef#

# InclusionProtectionGroupFiltersTypeDef TypedDict usage example

from types_boto3_shield.type_defs import InclusionProtectionGroupFiltersTypeDef


def get_value() -> InclusionProtectionGroupFiltersTypeDef:
    return {
        "ProtectionGroupIds": ...,
    }


# 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 Sequence[ProtectionGroupPatternType]
  2. See Sequence[ProtectedResourceTypeType]
  3. See Sequence[ProtectionGroupAggregationType]

LimitTypeDef#

# LimitTypeDef TypedDict usage example

from types_boto3_shield.type_defs import LimitTypeDef


def get_value() -> LimitTypeDef:
    return {
        "Type": ...,
    }


# LimitTypeDef definition

class LimitTypeDef(TypedDict):
    Type: NotRequired[str],
    Max: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_shield.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListResourcesInProtectionGroupRequestTypeDef#

# ListResourcesInProtectionGroupRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListResourcesInProtectionGroupRequestTypeDef


def get_value() -> ListResourcesInProtectionGroupRequestTypeDef:
    return {
        "ProtectionGroupId": ...,
    }


# ListResourcesInProtectionGroupRequestTypeDef definition

class ListResourcesInProtectionGroupRequestTypeDef(TypedDict):
    ProtectionGroupId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    ResourceARN: str,

ProtectionGroupArbitraryPatternLimitsTypeDef#

# ProtectionGroupArbitraryPatternLimitsTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ProtectionGroupArbitraryPatternLimitsTypeDef


def get_value() -> ProtectionGroupArbitraryPatternLimitsTypeDef:
    return {
        "MaxMembers": ...,
    }


# ProtectionGroupArbitraryPatternLimitsTypeDef definition

class ProtectionGroupArbitraryPatternLimitsTypeDef(TypedDict):
    MaxMembers: int,

ResponseActionTypeDef#

# ResponseActionTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ResponseActionTypeDef


def get_value() -> ResponseActionTypeDef:
    return {
        "Block": ...,
    }


# ResponseActionTypeDef definition

class ResponseActionTypeDef(TypedDict):
    Block: NotRequired[Mapping[str, Any]],
    Count: NotRequired[Mapping[str, Any]],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

UpdateProtectionGroupRequestTypeDef#

# UpdateProtectionGroupRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import UpdateProtectionGroupRequestTypeDef


def get_value() -> UpdateProtectionGroupRequestTypeDef:
    return {
        "ProtectionGroupId": ...,
    }


# UpdateProtectionGroupRequestTypeDef definition

class UpdateProtectionGroupRequestTypeDef(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

UpdateSubscriptionRequestTypeDef#

# UpdateSubscriptionRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import UpdateSubscriptionRequestTypeDef


def get_value() -> UpdateSubscriptionRequestTypeDef:
    return {
        "AutoRenew": ...,
    }


# UpdateSubscriptionRequestTypeDef definition

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

ApplicationLayerAutomaticResponseConfigurationTypeDef#

# ApplicationLayerAutomaticResponseConfigurationTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ApplicationLayerAutomaticResponseConfigurationTypeDef


def get_value() -> ApplicationLayerAutomaticResponseConfigurationTypeDef:
    return {
        "Status": ...,
    }


# ApplicationLayerAutomaticResponseConfigurationTypeDef definition

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

AssociateProactiveEngagementDetailsRequestTypeDef#

# AssociateProactiveEngagementDetailsRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AssociateProactiveEngagementDetailsRequestTypeDef


def get_value() -> AssociateProactiveEngagementDetailsRequestTypeDef:
    return {
        "EmergencyContactList": ...,
    }


# AssociateProactiveEngagementDetailsRequestTypeDef definition

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

UpdateEmergencyContactSettingsRequestTypeDef#

# UpdateEmergencyContactSettingsRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import UpdateEmergencyContactSettingsRequestTypeDef


def get_value() -> UpdateEmergencyContactSettingsRequestTypeDef:
    return {
        "EmergencyContactList": ...,
    }


# UpdateEmergencyContactSettingsRequestTypeDef definition

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

SummarizedAttackVectorTypeDef#

# SummarizedAttackVectorTypeDef TypedDict usage example

from types_boto3_shield.type_defs import SummarizedAttackVectorTypeDef


def get_value() -> SummarizedAttackVectorTypeDef:
    return {
        "VectorType": ...,
    }


# SummarizedAttackVectorTypeDef definition

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

AttackPropertyTypeDef#

# AttackPropertyTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AttackPropertyTypeDef


def get_value() -> AttackPropertyTypeDef:
    return {
        "AttackLayer": ...,
    }


# 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 List[ContributorTypeDef]
  4. See UnitType

AttackSummaryTypeDef#

# AttackSummaryTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AttackSummaryTypeDef


def get_value() -> AttackSummaryTypeDef:
    return {
        "AttackId": ...,
    }


# AttackSummaryTypeDef definition

class AttackSummaryTypeDef(TypedDict):
    AttackId: NotRequired[str],
    ResourceArn: NotRequired[str],
    StartTime: NotRequired[datetime.datetime],
    EndTime: NotRequired[datetime.datetime],
    AttackVectors: NotRequired[List[AttackVectorDescriptionTypeDef]],  # (1)
  1. See List[AttackVectorDescriptionTypeDef]

AttackVolumeTypeDef#

# AttackVolumeTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AttackVolumeTypeDef


def get_value() -> AttackVolumeTypeDef:
    return {
        "BitsPerSecond": ...,
    }


# 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

CreateProtectionGroupRequestTypeDef#

# CreateProtectionGroupRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import CreateProtectionGroupRequestTypeDef


def get_value() -> CreateProtectionGroupRequestTypeDef:
    return {
        "ProtectionGroupId": ...,
    }


# CreateProtectionGroupRequestTypeDef definition

class CreateProtectionGroupRequestTypeDef(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 Sequence[TagTypeDef]

CreateProtectionRequestTypeDef#

# CreateProtectionRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import CreateProtectionRequestTypeDef


def get_value() -> CreateProtectionRequestTypeDef:
    return {
        "Name": ...,
    }


# CreateProtectionRequestTypeDef definition

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

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "ResourceARN": ...,
    }


# TagResourceRequestTypeDef definition

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

CreateProtectionResponseTypeDef#

# CreateProtectionResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import CreateProtectionResponseTypeDef


def get_value() -> CreateProtectionResponseTypeDef:
    return {
        "ProtectionId": ...,
    }


# CreateProtectionResponseTypeDef definition

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

DescribeDRTAccessResponseTypeDef#

# DescribeDRTAccessResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeDRTAccessResponseTypeDef


def get_value() -> DescribeDRTAccessResponseTypeDef:
    return {
        "RoleArn": ...,
    }


# DescribeDRTAccessResponseTypeDef definition

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

DescribeEmergencyContactSettingsResponseTypeDef#

# DescribeEmergencyContactSettingsResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeEmergencyContactSettingsResponseTypeDef


def get_value() -> DescribeEmergencyContactSettingsResponseTypeDef:
    return {
        "EmergencyContactList": ...,
    }


# DescribeEmergencyContactSettingsResponseTypeDef definition

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

GetSubscriptionStateResponseTypeDef#

# GetSubscriptionStateResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import GetSubscriptionStateResponseTypeDef


def get_value() -> GetSubscriptionStateResponseTypeDef:
    return {
        "SubscriptionState": ...,
    }


# GetSubscriptionStateResponseTypeDef definition

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

ListResourcesInProtectionGroupResponseTypeDef#

# ListResourcesInProtectionGroupResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListResourcesInProtectionGroupResponseTypeDef


def get_value() -> ListResourcesInProtectionGroupResponseTypeDef:
    return {
        "ResourceArns": ...,
    }


# ListResourcesInProtectionGroupResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "Tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See List[TagTypeDef]
  2. See ResponseMetadataTypeDef

DescribeProtectionGroupResponseTypeDef#

# DescribeProtectionGroupResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeProtectionGroupResponseTypeDef


def get_value() -> DescribeProtectionGroupResponseTypeDef:
    return {
        "ProtectionGroup": ...,
    }


# DescribeProtectionGroupResponseTypeDef definition

class DescribeProtectionGroupResponseTypeDef(TypedDict):
    ProtectionGroup: ProtectionGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProtectionGroupTypeDef
  2. See ResponseMetadataTypeDef

ListProtectionGroupsResponseTypeDef#

# ListProtectionGroupsResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListProtectionGroupsResponseTypeDef


def get_value() -> ListProtectionGroupsResponseTypeDef:
    return {
        "ProtectionGroups": ...,
    }


# ListProtectionGroupsResponseTypeDef definition

class ListProtectionGroupsResponseTypeDef(TypedDict):
    ProtectionGroups: List[ProtectionGroupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[ProtectionGroupTypeDef]
  2. See ResponseMetadataTypeDef

ListProtectionsRequestTypeDef#

# ListProtectionsRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListProtectionsRequestTypeDef


def get_value() -> ListProtectionsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListProtectionsRequestTypeDef definition

class ListProtectionsRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    InclusionFilters: NotRequired[InclusionProtectionFiltersTypeDef],  # (1)
  1. See InclusionProtectionFiltersTypeDef

ListProtectionGroupsRequestTypeDef#

# ListProtectionGroupsRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListProtectionGroupsRequestTypeDef


def get_value() -> ListProtectionGroupsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListProtectionGroupsRequestTypeDef definition

class ListProtectionGroupsRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    InclusionFilters: NotRequired[InclusionProtectionGroupFiltersTypeDef],  # (1)
  1. See InclusionProtectionGroupFiltersTypeDef

ProtectionLimitsTypeDef#

# ProtectionLimitsTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ProtectionLimitsTypeDef


def get_value() -> ProtectionLimitsTypeDef:
    return {
        "ProtectedResourceTypeLimits": ...,
    }


# ProtectionLimitsTypeDef definition

class ProtectionLimitsTypeDef(TypedDict):
    ProtectedResourceTypeLimits: List[LimitTypeDef],  # (1)
  1. See List[LimitTypeDef]

ListProtectionsRequestPaginateTypeDef#

# ListProtectionsRequestPaginateTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListProtectionsRequestPaginateTypeDef


def get_value() -> ListProtectionsRequestPaginateTypeDef:
    return {
        "InclusionFilters": ...,
    }


# ListProtectionsRequestPaginateTypeDef definition

class ListProtectionsRequestPaginateTypeDef(TypedDict):
    InclusionFilters: NotRequired[InclusionProtectionFiltersTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See InclusionProtectionFiltersTypeDef
  2. See PaginatorConfigTypeDef

ProtectionGroupPatternTypeLimitsTypeDef#

# ProtectionGroupPatternTypeLimitsTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ProtectionGroupPatternTypeLimitsTypeDef


def get_value() -> ProtectionGroupPatternTypeLimitsTypeDef:
    return {
        "ArbitraryPatternLimits": ...,
    }


# ProtectionGroupPatternTypeLimitsTypeDef definition

class ProtectionGroupPatternTypeLimitsTypeDef(TypedDict):
    ArbitraryPatternLimits: ProtectionGroupArbitraryPatternLimitsTypeDef,  # (1)
  1. See ProtectionGroupArbitraryPatternLimitsTypeDef

TimeRangeTypeDef#

# TimeRangeTypeDef TypedDict usage example

from types_boto3_shield.type_defs import TimeRangeTypeDef


def get_value() -> TimeRangeTypeDef:
    return {
        "FromInclusive": ...,
    }


# TimeRangeTypeDef definition

class TimeRangeTypeDef(TypedDict):
    FromInclusive: NotRequired[TimestampTypeDef],
    ToExclusive: NotRequired[TimestampTypeDef],

ProtectionTypeDef#

# ProtectionTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ProtectionTypeDef


def get_value() -> ProtectionTypeDef:
    return {
        "Id": ...,
    }


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

SubResourceSummaryTypeDef#

# SubResourceSummaryTypeDef TypedDict usage example

from types_boto3_shield.type_defs import SubResourceSummaryTypeDef


def get_value() -> SubResourceSummaryTypeDef:
    return {
        "Type": ...,
    }


# SubResourceSummaryTypeDef definition

class SubResourceSummaryTypeDef(TypedDict):
    Type: NotRequired[SubResourceTypeType],  # (1)
    Id: NotRequired[str],
    AttackVectors: NotRequired[List[SummarizedAttackVectorTypeDef]],  # (2)
    Counters: NotRequired[List[SummarizedCounterTypeDef]],  # (3)
  1. See SubResourceTypeType
  2. See List[SummarizedAttackVectorTypeDef]
  3. See List[SummarizedCounterTypeDef]

ListAttacksResponseTypeDef#

# ListAttacksResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListAttacksResponseTypeDef


def get_value() -> ListAttacksResponseTypeDef:
    return {
        "AttackSummaries": ...,
    }


# ListAttacksResponseTypeDef definition

class ListAttacksResponseTypeDef(TypedDict):
    AttackSummaries: List[AttackSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[AttackSummaryTypeDef]
  2. See ResponseMetadataTypeDef

AttackStatisticsDataItemTypeDef#

# AttackStatisticsDataItemTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AttackStatisticsDataItemTypeDef


def get_value() -> AttackStatisticsDataItemTypeDef:
    return {
        "AttackVolume": ...,
    }


# AttackStatisticsDataItemTypeDef definition

class AttackStatisticsDataItemTypeDef(TypedDict):
    AttackCount: int,
    AttackVolume: NotRequired[AttackVolumeTypeDef],  # (1)
  1. See AttackVolumeTypeDef

ProtectionGroupLimitsTypeDef#

# ProtectionGroupLimitsTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ProtectionGroupLimitsTypeDef


def get_value() -> ProtectionGroupLimitsTypeDef:
    return {
        "MaxProtectionGroups": ...,
    }


# ProtectionGroupLimitsTypeDef definition

class ProtectionGroupLimitsTypeDef(TypedDict):
    MaxProtectionGroups: int,
    PatternTypeLimits: ProtectionGroupPatternTypeLimitsTypeDef,  # (1)
  1. See ProtectionGroupPatternTypeLimitsTypeDef

EnableApplicationLayerAutomaticResponseRequestTypeDef#

# EnableApplicationLayerAutomaticResponseRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import EnableApplicationLayerAutomaticResponseRequestTypeDef


def get_value() -> EnableApplicationLayerAutomaticResponseRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# EnableApplicationLayerAutomaticResponseRequestTypeDef definition

class EnableApplicationLayerAutomaticResponseRequestTypeDef(TypedDict):
    ResourceArn: str,
    Action: ResponseActionUnionTypeDef,  # (1)
  1. See ResponseActionUnionTypeDef

UpdateApplicationLayerAutomaticResponseRequestTypeDef#

# UpdateApplicationLayerAutomaticResponseRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import UpdateApplicationLayerAutomaticResponseRequestTypeDef


def get_value() -> UpdateApplicationLayerAutomaticResponseRequestTypeDef:
    return {
        "ResourceArn": ...,
    }


# UpdateApplicationLayerAutomaticResponseRequestTypeDef definition

class UpdateApplicationLayerAutomaticResponseRequestTypeDef(TypedDict):
    ResourceArn: str,
    Action: ResponseActionUnionTypeDef,  # (1)
  1. See ResponseActionUnionTypeDef

DescribeProtectionResponseTypeDef#

# DescribeProtectionResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeProtectionResponseTypeDef


def get_value() -> DescribeProtectionResponseTypeDef:
    return {
        "Protection": ...,
    }


# DescribeProtectionResponseTypeDef definition

class DescribeProtectionResponseTypeDef(TypedDict):
    Protection: ProtectionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProtectionTypeDef
  2. See ResponseMetadataTypeDef

ListProtectionsResponseTypeDef#

# ListProtectionsResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListProtectionsResponseTypeDef


def get_value() -> ListProtectionsResponseTypeDef:
    return {
        "Protections": ...,
    }


# ListProtectionsResponseTypeDef definition

class ListProtectionsResponseTypeDef(TypedDict):
    Protections: List[ProtectionTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See List[ProtectionTypeDef]
  2. See ResponseMetadataTypeDef

AttackDetailTypeDef#

# AttackDetailTypeDef TypedDict usage example

from types_boto3_shield.type_defs import AttackDetailTypeDef


def get_value() -> AttackDetailTypeDef:
    return {
        "AttackId": ...,
    }


# AttackDetailTypeDef definition

class AttackDetailTypeDef(TypedDict):
    AttackId: NotRequired[str],
    ResourceArn: NotRequired[str],
    SubResources: NotRequired[List[SubResourceSummaryTypeDef]],  # (1)
    StartTime: NotRequired[datetime.datetime],
    EndTime: NotRequired[datetime.datetime],
    AttackCounters: NotRequired[List[SummarizedCounterTypeDef]],  # (2)
    AttackProperties: NotRequired[List[AttackPropertyTypeDef]],  # (3)
    Mitigations: NotRequired[List[MitigationTypeDef]],  # (4)
  1. See List[SubResourceSummaryTypeDef]
  2. See List[SummarizedCounterTypeDef]
  3. See List[AttackPropertyTypeDef]
  4. See List[MitigationTypeDef]

DescribeAttackStatisticsResponseTypeDef#

# DescribeAttackStatisticsResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeAttackStatisticsResponseTypeDef


def get_value() -> DescribeAttackStatisticsResponseTypeDef:
    return {
        "TimeRange": ...,
    }


# DescribeAttackStatisticsResponseTypeDef definition

class DescribeAttackStatisticsResponseTypeDef(TypedDict):
    TimeRange: TimeRangeOutputTypeDef,  # (1)
    DataItems: List[AttackStatisticsDataItemTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See TimeRangeOutputTypeDef
  2. See List[AttackStatisticsDataItemTypeDef]
  3. See ResponseMetadataTypeDef

SubscriptionLimitsTypeDef#

# SubscriptionLimitsTypeDef TypedDict usage example

from types_boto3_shield.type_defs import SubscriptionLimitsTypeDef


def get_value() -> SubscriptionLimitsTypeDef:
    return {
        "ProtectionLimits": ...,
    }


# SubscriptionLimitsTypeDef definition

class SubscriptionLimitsTypeDef(TypedDict):
    ProtectionLimits: ProtectionLimitsTypeDef,  # (1)
    ProtectionGroupLimits: ProtectionGroupLimitsTypeDef,  # (2)
  1. See ProtectionLimitsTypeDef
  2. See ProtectionGroupLimitsTypeDef

ListAttacksRequestPaginateTypeDef#

# ListAttacksRequestPaginateTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListAttacksRequestPaginateTypeDef


def get_value() -> ListAttacksRequestPaginateTypeDef:
    return {
        "ResourceArns": ...,
    }


# ListAttacksRequestPaginateTypeDef definition

class ListAttacksRequestPaginateTypeDef(TypedDict):
    ResourceArns: NotRequired[Sequence[str]],
    StartTime: NotRequired[TimeRangeUnionTypeDef],  # (1)
    EndTime: NotRequired[TimeRangeUnionTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See TimeRangeUnionTypeDef
  2. See TimeRangeUnionTypeDef
  3. See PaginatorConfigTypeDef

ListAttacksRequestTypeDef#

# ListAttacksRequestTypeDef TypedDict usage example

from types_boto3_shield.type_defs import ListAttacksRequestTypeDef


def get_value() -> ListAttacksRequestTypeDef:
    return {
        "ResourceArns": ...,
    }


# ListAttacksRequestTypeDef definition

class ListAttacksRequestTypeDef(TypedDict):
    ResourceArns: NotRequired[Sequence[str]],
    StartTime: NotRequired[TimeRangeUnionTypeDef],  # (1)
    EndTime: NotRequired[TimeRangeUnionTypeDef],  # (1)
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See TimeRangeUnionTypeDef
  2. See TimeRangeUnionTypeDef

DescribeAttackResponseTypeDef#

# DescribeAttackResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeAttackResponseTypeDef


def get_value() -> DescribeAttackResponseTypeDef:
    return {
        "Attack": ...,
    }


# DescribeAttackResponseTypeDef definition

class DescribeAttackResponseTypeDef(TypedDict):
    Attack: AttackDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AttackDetailTypeDef
  2. See ResponseMetadataTypeDef

SubscriptionTypeDef#

# SubscriptionTypeDef TypedDict usage example

from types_boto3_shield.type_defs import SubscriptionTypeDef


def get_value() -> SubscriptionTypeDef:
    return {
        "StartTime": ...,
    }


# SubscriptionTypeDef definition

class SubscriptionTypeDef(TypedDict):
    SubscriptionLimits: SubscriptionLimitsTypeDef,  # (4)
    StartTime: NotRequired[datetime.datetime],
    EndTime: NotRequired[datetime.datetime],
    TimeCommitmentInSeconds: NotRequired[int],
    AutoRenew: NotRequired[AutoRenewType],  # (1)
    Limits: NotRequired[List[LimitTypeDef]],  # (2)
    ProactiveEngagementStatus: NotRequired[ProactiveEngagementStatusType],  # (3)
    SubscriptionArn: NotRequired[str],
  1. See AutoRenewType
  2. See List[LimitTypeDef]
  3. See ProactiveEngagementStatusType
  4. See SubscriptionLimitsTypeDef

DescribeSubscriptionResponseTypeDef#

# DescribeSubscriptionResponseTypeDef TypedDict usage example

from types_boto3_shield.type_defs import DescribeSubscriptionResponseTypeDef


def get_value() -> DescribeSubscriptionResponseTypeDef:
    return {
        "Subscription": ...,
    }


# DescribeSubscriptionResponseTypeDef definition

class DescribeSubscriptionResponseTypeDef(TypedDict):
    Subscription: SubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionTypeDef
  2. See ResponseMetadataTypeDef