Skip to content

Typed dictionaries

Index > SecurityHub > Typed dictionaries

Auto-generated documentation for SecurityHub type annotations stubs module mypy-boto3-securityhub.

AcceptAdministratorInvitationRequestRequestTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AcceptAdministratorInvitationRequestRequestTypeDef

def get_value() -> AcceptAdministratorInvitationRequestRequestTypeDef:
    return {
        "AdministratorId": ...,
        "InvitationId": ...,
    }
Definition
class AcceptAdministratorInvitationRequestRequestTypeDef(TypedDict):
    AdministratorId: str,
    InvitationId: str,

AcceptInvitationRequestRequestTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AcceptInvitationRequestRequestTypeDef

def get_value() -> AcceptInvitationRequestRequestTypeDef:
    return {
        "MasterId": ...,
        "InvitationId": ...,
    }
Definition
class AcceptInvitationRequestRequestTypeDef(TypedDict):
    MasterId: str,
    InvitationId: str,

AccountDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AccountDetailsTypeDef

def get_value() -> AccountDetailsTypeDef:
    return {
        "AccountId": ...,
    }
Definition
class AccountDetailsTypeDef(TypedDict):
    AccountId: str,
    Email: NotRequired[str],

ActionLocalIpDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import ActionLocalIpDetailsTypeDef

def get_value() -> ActionLocalIpDetailsTypeDef:
    return {
        "IpAddressV4": ...,
    }
Definition
class ActionLocalIpDetailsTypeDef(TypedDict):
    IpAddressV4: NotRequired[str],

ActionLocalPortDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import ActionLocalPortDetailsTypeDef

def get_value() -> ActionLocalPortDetailsTypeDef:
    return {
        "Port": ...,
    }
Definition
class ActionLocalPortDetailsTypeDef(TypedDict):
    Port: NotRequired[int],
    PortName: NotRequired[str],

CityTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import CityTypeDef

def get_value() -> CityTypeDef:
    return {
        "CityName": ...,
    }
Definition
class CityTypeDef(TypedDict):
    CityName: NotRequired[str],

CountryTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import CountryTypeDef

def get_value() -> CountryTypeDef:
    return {
        "CountryCode": ...,
    }
Definition
class CountryTypeDef(TypedDict):
    CountryCode: NotRequired[str],
    CountryName: NotRequired[str],

GeoLocationTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import GeoLocationTypeDef

def get_value() -> GeoLocationTypeDef:
    return {
        "Lon": ...,
    }
Definition
class GeoLocationTypeDef(TypedDict):
    Lon: NotRequired[float],
    Lat: NotRequired[float],

IpOrganizationDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import IpOrganizationDetailsTypeDef

def get_value() -> IpOrganizationDetailsTypeDef:
    return {
        "Asn": ...,
    }
Definition
class IpOrganizationDetailsTypeDef(TypedDict):
    Asn: NotRequired[int],
    AsnOrg: NotRequired[str],
    Isp: NotRequired[str],
    Org: NotRequired[str],

ActionRemotePortDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import ActionRemotePortDetailsTypeDef

def get_value() -> ActionRemotePortDetailsTypeDef:
    return {
        "Port": ...,
    }
Definition
class ActionRemotePortDetailsTypeDef(TypedDict):
    Port: NotRequired[int],
    PortName: NotRequired[str],

ActionTargetTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import ActionTargetTypeDef

def get_value() -> ActionTargetTypeDef:
    return {
        "ActionTargetArn": ...,
        "Name": ...,
        "Description": ...,
    }
Definition
class ActionTargetTypeDef(TypedDict):
    ActionTargetArn: str,
    Name: str,
    Description: str,

DnsRequestActionTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import DnsRequestActionTypeDef

def get_value() -> DnsRequestActionTypeDef:
    return {
        "Domain": ...,
    }
Definition
class DnsRequestActionTypeDef(TypedDict):
    Domain: NotRequired[str],
    Protocol: NotRequired[str],
    Blocked: NotRequired[bool],

AdjustmentTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AdjustmentTypeDef

def get_value() -> AdjustmentTypeDef:
    return {
        "Metric": ...,
    }
Definition
class AdjustmentTypeDef(TypedDict):
    Metric: NotRequired[str],
    Reason: NotRequired[str],

AdminAccountTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AdminAccountTypeDef

def get_value() -> AdminAccountTypeDef:
    return {
        "AccountId": ...,
    }
Definition
class AdminAccountTypeDef(TypedDict):
    AccountId: NotRequired[str],
    Status: NotRequired[AdminStatusType],  # (1)
  1. See AdminStatusType

AssociatedStandardTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AssociatedStandardTypeDef

def get_value() -> AssociatedStandardTypeDef:
    return {
        "StandardsId": ...,
    }
Definition
class AssociatedStandardTypeDef(TypedDict):
    StandardsId: NotRequired[str],

AvailabilityZoneTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AvailabilityZoneTypeDef

def get_value() -> AvailabilityZoneTypeDef:
    return {
        "ZoneName": ...,
    }
Definition
class AvailabilityZoneTypeDef(TypedDict):
    ZoneName: NotRequired[str],
    SubnetId: NotRequired[str],

AwsApiCallActionDomainDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsApiCallActionDomainDetailsTypeDef

def get_value() -> AwsApiCallActionDomainDetailsTypeDef:
    return {
        "Domain": ...,
    }
Definition
class AwsApiCallActionDomainDetailsTypeDef(TypedDict):
    Domain: NotRequired[str],

AwsApiGatewayAccessLogSettingsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsApiGatewayAccessLogSettingsTypeDef

def get_value() -> AwsApiGatewayAccessLogSettingsTypeDef:
    return {
        "Format": ...,
    }
Definition
class AwsApiGatewayAccessLogSettingsTypeDef(TypedDict):
    Format: NotRequired[str],
    DestinationArn: NotRequired[str],

AwsApiGatewayCanarySettingsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsApiGatewayCanarySettingsTypeDef

def get_value() -> AwsApiGatewayCanarySettingsTypeDef:
    return {
        "PercentTraffic": ...,
    }
Definition
class AwsApiGatewayCanarySettingsTypeDef(TypedDict):
    PercentTraffic: NotRequired[float],
    DeploymentId: NotRequired[str],
    StageVariableOverrides: NotRequired[Mapping[str, str]],
    UseStageCache: NotRequired[bool],

AwsApiGatewayEndpointConfigurationTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsApiGatewayEndpointConfigurationTypeDef

def get_value() -> AwsApiGatewayEndpointConfigurationTypeDef:
    return {
        "Types": ...,
    }
Definition
class AwsApiGatewayEndpointConfigurationTypeDef(TypedDict):
    Types: NotRequired[Sequence[str]],

AwsApiGatewayMethodSettingsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsApiGatewayMethodSettingsTypeDef

def get_value() -> AwsApiGatewayMethodSettingsTypeDef:
    return {
        "MetricsEnabled": ...,
    }
Definition
class AwsApiGatewayMethodSettingsTypeDef(TypedDict):
    MetricsEnabled: NotRequired[bool],
    LoggingLevel: NotRequired[str],
    DataTraceEnabled: NotRequired[bool],
    ThrottlingBurstLimit: NotRequired[int],
    ThrottlingRateLimit: NotRequired[float],
    CachingEnabled: NotRequired[bool],
    CacheTtlInSeconds: NotRequired[int],
    CacheDataEncrypted: NotRequired[bool],
    RequireAuthorizationForCacheControl: NotRequired[bool],
    UnauthorizedCacheControlHeaderStrategy: NotRequired[str],
    HttpMethod: NotRequired[str],
    ResourcePath: NotRequired[str],

AwsCorsConfigurationTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCorsConfigurationTypeDef

def get_value() -> AwsCorsConfigurationTypeDef:
    return {
        "AllowOrigins": ...,
    }
Definition
class AwsCorsConfigurationTypeDef(TypedDict):
    AllowOrigins: NotRequired[Sequence[str]],
    AllowCredentials: NotRequired[bool],
    ExposeHeaders: NotRequired[Sequence[str]],
    MaxAge: NotRequired[int],
    AllowMethods: NotRequired[Sequence[str]],
    AllowHeaders: NotRequired[Sequence[str]],

AwsApiGatewayV2RouteSettingsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsApiGatewayV2RouteSettingsTypeDef

def get_value() -> AwsApiGatewayV2RouteSettingsTypeDef:
    return {
        "DetailedMetricsEnabled": ...,
    }
Definition
class AwsApiGatewayV2RouteSettingsTypeDef(TypedDict):
    DetailedMetricsEnabled: NotRequired[bool],
    LoggingLevel: NotRequired[str],
    DataTraceEnabled: NotRequired[bool],
    ThrottlingBurstLimit: NotRequired[int],
    ThrottlingRateLimit: NotRequired[float],

AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetailsTypeDef

def get_value() -> AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetailsTypeDef:
    return {
        "Value": ...,
    }
Definition
class AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetailsTypeDef(TypedDict):
    Value: NotRequired[str],

AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecificationTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecificationTypeDef

def get_value() -> AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecificationTypeDef:
    return {
        "LaunchTemplateId": ...,
    }
Definition
class AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecificationTypeDef(TypedDict):
    LaunchTemplateId: NotRequired[str],
    LaunchTemplateName: NotRequired[str],
    Version: NotRequired[str],

AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetailsTypeDef

def get_value() -> AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetailsTypeDef:
    return {
        "OnDemandAllocationStrategy": ...,
    }
Definition
class AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetailsTypeDef(TypedDict):
    OnDemandAllocationStrategy: NotRequired[str],
    OnDemandBaseCapacity: NotRequired[int],
    OnDemandPercentageAboveBaseCapacity: NotRequired[int],
    SpotAllocationStrategy: NotRequired[str],
    SpotInstancePools: NotRequired[int],
    SpotMaxPrice: NotRequired[str],

AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecificationTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecificationTypeDef

def get_value() -> AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecificationTypeDef:
    return {
        "LaunchTemplateId": ...,
    }
Definition
class AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecificationTypeDef(TypedDict):
    LaunchTemplateId: NotRequired[str],
    LaunchTemplateName: NotRequired[str],
    Version: NotRequired[str],

AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetailsTypeDef

def get_value() -> AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetailsTypeDef:
    return {
        "InstanceType": ...,
    }
Definition
class AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetailsTypeDef(TypedDict):
    InstanceType: NotRequired[str],
    WeightedCapacity: NotRequired[str],

AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetailsTypeDef

def get_value() -> AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetailsTypeDef:
    return {
        "DeleteOnTermination": ...,
    }
Definition
class AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetailsTypeDef(TypedDict):
    DeleteOnTermination: NotRequired[bool],
    Encrypted: NotRequired[bool],
    Iops: NotRequired[int],
    SnapshotId: NotRequired[str],
    VolumeSize: NotRequired[int],
    VolumeType: NotRequired[str],

AwsAutoScalingLaunchConfigurationInstanceMonitoringDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsAutoScalingLaunchConfigurationInstanceMonitoringDetailsTypeDef

def get_value() -> AwsAutoScalingLaunchConfigurationInstanceMonitoringDetailsTypeDef:
    return {
        "Enabled": ...,
    }
Definition
class AwsAutoScalingLaunchConfigurationInstanceMonitoringDetailsTypeDef(TypedDict):
    Enabled: NotRequired[bool],

AwsAutoScalingLaunchConfigurationMetadataOptionsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsAutoScalingLaunchConfigurationMetadataOptionsTypeDef

def get_value() -> AwsAutoScalingLaunchConfigurationMetadataOptionsTypeDef:
    return {
        "HttpEndpoint": ...,
    }
Definition
class AwsAutoScalingLaunchConfigurationMetadataOptionsTypeDef(TypedDict):
    HttpEndpoint: NotRequired[str],
    HttpPutResponseHopLimit: NotRequired[int],
    HttpTokens: NotRequired[str],

AwsBackupBackupPlanAdvancedBackupSettingsDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsBackupBackupPlanAdvancedBackupSettingsDetailsTypeDef

def get_value() -> AwsBackupBackupPlanAdvancedBackupSettingsDetailsTypeDef:
    return {
        "BackupOptions": ...,
    }
Definition
class AwsBackupBackupPlanAdvancedBackupSettingsDetailsTypeDef(TypedDict):
    BackupOptions: NotRequired[Mapping[str, str]],
    ResourceType: NotRequired[str],

AwsBackupBackupPlanLifecycleDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsBackupBackupPlanLifecycleDetailsTypeDef

def get_value() -> AwsBackupBackupPlanLifecycleDetailsTypeDef:
    return {
        "DeleteAfterDays": ...,
    }
Definition
class AwsBackupBackupPlanLifecycleDetailsTypeDef(TypedDict):
    DeleteAfterDays: NotRequired[int],
    MoveToColdStorageAfterDays: NotRequired[int],

AwsBackupBackupVaultNotificationsDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsBackupBackupVaultNotificationsDetailsTypeDef

def get_value() -> AwsBackupBackupVaultNotificationsDetailsTypeDef:
    return {
        "BackupVaultEvents": ...,
    }
Definition
class AwsBackupBackupVaultNotificationsDetailsTypeDef(TypedDict):
    BackupVaultEvents: NotRequired[Sequence[str]],
    SnsTopicArn: NotRequired[str],

AwsBackupRecoveryPointCalculatedLifecycleDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsBackupRecoveryPointCalculatedLifecycleDetailsTypeDef

def get_value() -> AwsBackupRecoveryPointCalculatedLifecycleDetailsTypeDef:
    return {
        "DeleteAt": ...,
    }
Definition
class AwsBackupRecoveryPointCalculatedLifecycleDetailsTypeDef(TypedDict):
    DeleteAt: NotRequired[str],
    MoveToColdStorageAt: NotRequired[str],

AwsBackupRecoveryPointCreatedByDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsBackupRecoveryPointCreatedByDetailsTypeDef

def get_value() -> AwsBackupRecoveryPointCreatedByDetailsTypeDef:
    return {
        "BackupPlanArn": ...,
    }
Definition
class AwsBackupRecoveryPointCreatedByDetailsTypeDef(TypedDict):
    BackupPlanArn: NotRequired[str],
    BackupPlanId: NotRequired[str],
    BackupPlanVersion: NotRequired[str],
    BackupRuleId: NotRequired[str],

AwsBackupRecoveryPointLifecycleDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsBackupRecoveryPointLifecycleDetailsTypeDef

def get_value() -> AwsBackupRecoveryPointLifecycleDetailsTypeDef:
    return {
        "DeleteAfterDays": ...,
    }
Definition
class AwsBackupRecoveryPointLifecycleDetailsTypeDef(TypedDict):
    DeleteAfterDays: NotRequired[int],
    MoveToColdStorageAfterDays: NotRequired[int],

AwsCertificateManagerCertificateExtendedKeyUsageTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCertificateManagerCertificateExtendedKeyUsageTypeDef

def get_value() -> AwsCertificateManagerCertificateExtendedKeyUsageTypeDef:
    return {
        "Name": ...,
    }
Definition
class AwsCertificateManagerCertificateExtendedKeyUsageTypeDef(TypedDict):
    Name: NotRequired[str],
    OId: NotRequired[str],

AwsCertificateManagerCertificateKeyUsageTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCertificateManagerCertificateKeyUsageTypeDef

def get_value() -> AwsCertificateManagerCertificateKeyUsageTypeDef:
    return {
        "Name": ...,
    }
Definition
class AwsCertificateManagerCertificateKeyUsageTypeDef(TypedDict):
    Name: NotRequired[str],

AwsCertificateManagerCertificateOptionsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCertificateManagerCertificateOptionsTypeDef

def get_value() -> AwsCertificateManagerCertificateOptionsTypeDef:
    return {
        "CertificateTransparencyLoggingPreference": ...,
    }
Definition
class AwsCertificateManagerCertificateOptionsTypeDef(TypedDict):
    CertificateTransparencyLoggingPreference: NotRequired[str],

AwsCertificateManagerCertificateResourceRecordTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCertificateManagerCertificateResourceRecordTypeDef

def get_value() -> AwsCertificateManagerCertificateResourceRecordTypeDef:
    return {
        "Name": ...,
    }
Definition
class AwsCertificateManagerCertificateResourceRecordTypeDef(TypedDict):
    Name: NotRequired[str],
    Type: NotRequired[str],
    Value: NotRequired[str],

AwsCloudFormationStackDriftInformationDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCloudFormationStackDriftInformationDetailsTypeDef

def get_value() -> AwsCloudFormationStackDriftInformationDetailsTypeDef:
    return {
        "StackDriftStatus": ...,
    }
Definition
class AwsCloudFormationStackDriftInformationDetailsTypeDef(TypedDict):
    StackDriftStatus: NotRequired[str],

AwsCloudFormationStackOutputsDetailsTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCloudFormationStackOutputsDetailsTypeDef

def get_value() -> AwsCloudFormationStackOutputsDetailsTypeDef:
    return {
        "Description": ...,
    }
Definition
class AwsCloudFormationStackOutputsDetailsTypeDef(TypedDict):
    Description: NotRequired[str],
    OutputKey: NotRequired[str],
    OutputValue: NotRequired[str],

AwsCloudFrontDistributionCacheBehaviorTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCloudFrontDistributionCacheBehaviorTypeDef

def get_value() -> AwsCloudFrontDistributionCacheBehaviorTypeDef:
    return {
        "ViewerProtocolPolicy": ...,
    }
Definition
class AwsCloudFrontDistributionCacheBehaviorTypeDef(TypedDict):
    ViewerProtocolPolicy: NotRequired[str],

AwsCloudFrontDistributionDefaultCacheBehaviorTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCloudFrontDistributionDefaultCacheBehaviorTypeDef

def get_value() -> AwsCloudFrontDistributionDefaultCacheBehaviorTypeDef:
    return {
        "ViewerProtocolPolicy": ...,
    }
Definition
class AwsCloudFrontDistributionDefaultCacheBehaviorTypeDef(TypedDict):
    ViewerProtocolPolicy: NotRequired[str],

AwsCloudFrontDistributionLoggingTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCloudFrontDistributionLoggingTypeDef

def get_value() -> AwsCloudFrontDistributionLoggingTypeDef:
    return {
        "Bucket": ...,
    }
Definition
class AwsCloudFrontDistributionLoggingTypeDef(TypedDict):
    Bucket: NotRequired[str],
    Enabled: NotRequired[bool],
    IncludeCookies: NotRequired[bool],
    Prefix: NotRequired[str],

AwsCloudFrontDistributionViewerCertificateTypeDef

Usage Example
from mypy_boto3_securityhub.type_defs import AwsCloudFrontDistributionViewerCertificateTypeDef

def get_value() -> AwsCloudFrontDistributionViewerCertificateTypeDef:
    return {
        "AcmCertificateArn": ...,
    }
Definition
class AwsCloudFrontDistributionViewerCertificateTypeDef(TypedDict):
    AcmCertificateArn: NotRequired[str],
    Certificate: NotRequired[str],
    CertificateSource: NotRequired[str],
    CloudFrontDefaultCertificate: NotRequired[bool],
    IamCertificateId: NotRequired[str],
    MinimumProtocolVersion: NotRequired[str],
    SslSupportMethod: NotRequired[str],

AwsCloudFrontDistributionOriginSslProtocolsTypeDef

Usage Example