Skip to content

Typed dictionaries#

Index > CloudWatchInternetMonitor > Typed dictionaries

Auto-generated documentation for CloudWatchInternetMonitor type annotations stubs module mypy-boto3-internetmonitor.

AvailabilityMeasurementTypeDef#

# AvailabilityMeasurementTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import AvailabilityMeasurementTypeDef

def get_value() -> AvailabilityMeasurementTypeDef:
    return {
        "ExperienceScore": ...,
    }
# AvailabilityMeasurementTypeDef definition

class AvailabilityMeasurementTypeDef(TypedDict):
    ExperienceScore: NotRequired[float],
    PercentOfTotalTrafficImpacted: NotRequired[float],
    PercentOfClientLocationImpacted: NotRequired[float],

CreateMonitorOutputTypeDef#

# CreateMonitorOutputTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import CreateMonitorOutputTypeDef

def get_value() -> CreateMonitorOutputTypeDef:
    return {
        "Arn": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
# CreateMonitorOutputTypeDef definition

class CreateMonitorOutputTypeDef(TypedDict):
    Arn: str,
    Status: MonitorConfigStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MonitorConfigStateType
  2. See ResponseMetadataTypeDef

DeleteMonitorInputRequestTypeDef#

# DeleteMonitorInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import DeleteMonitorInputRequestTypeDef

def get_value() -> DeleteMonitorInputRequestTypeDef:
    return {
        "MonitorName": ...,
    }
# DeleteMonitorInputRequestTypeDef definition

class DeleteMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,

GetHealthEventInputRequestTypeDef#

# GetHealthEventInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import GetHealthEventInputRequestTypeDef

def get_value() -> GetHealthEventInputRequestTypeDef:
    return {
        "MonitorName": ...,
        "EventId": ...,
    }
# GetHealthEventInputRequestTypeDef definition

class GetHealthEventInputRequestTypeDef(TypedDict):
    MonitorName: str,
    EventId: str,

GetMonitorInputRequestTypeDef#

# GetMonitorInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import GetMonitorInputRequestTypeDef

def get_value() -> GetMonitorInputRequestTypeDef:
    return {
        "MonitorName": ...,
    }
# GetMonitorInputRequestTypeDef definition

class GetMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,

S3ConfigTypeDef#

# S3ConfigTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import S3ConfigTypeDef

def get_value() -> S3ConfigTypeDef:
    return {
        "BucketName": ...,
    }
# S3ConfigTypeDef definition

class S3ConfigTypeDef(TypedDict):
    BucketName: NotRequired[str],
    BucketPrefix: NotRequired[str],
    LogDeliveryStatus: NotRequired[LogDeliveryStatusType],  # (1)
  1. See LogDeliveryStatusType

ListHealthEventsInputListHealthEventsPaginateTypeDef#

# ListHealthEventsInputListHealthEventsPaginateTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ListHealthEventsInputListHealthEventsPaginateTypeDef

def get_value() -> ListHealthEventsInputListHealthEventsPaginateTypeDef:
    return {
        "MonitorName": ...,
    }
# ListHealthEventsInputListHealthEventsPaginateTypeDef definition

class ListHealthEventsInputListHealthEventsPaginateTypeDef(TypedDict):
    MonitorName: str,
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    EventStatus: NotRequired[HealthEventStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See HealthEventStatusType
  2. See PaginatorConfigTypeDef

ListHealthEventsInputRequestTypeDef#

# ListHealthEventsInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ListHealthEventsInputRequestTypeDef

def get_value() -> ListHealthEventsInputRequestTypeDef:
    return {
        "MonitorName": ...,
    }
# ListHealthEventsInputRequestTypeDef definition

class ListHealthEventsInputRequestTypeDef(TypedDict):
    MonitorName: str,
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    EventStatus: NotRequired[HealthEventStatusType],  # (1)
  1. See HealthEventStatusType

ListMonitorsInputListMonitorsPaginateTypeDef#

# ListMonitorsInputListMonitorsPaginateTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ListMonitorsInputListMonitorsPaginateTypeDef

def get_value() -> ListMonitorsInputListMonitorsPaginateTypeDef:
    return {
        "MonitorStatus": ...,
    }
# ListMonitorsInputListMonitorsPaginateTypeDef definition

class ListMonitorsInputListMonitorsPaginateTypeDef(TypedDict):
    MonitorStatus: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMonitorsInputRequestTypeDef#

# ListMonitorsInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ListMonitorsInputRequestTypeDef

def get_value() -> ListMonitorsInputRequestTypeDef:
    return {
        "NextToken": ...,
    }
# ListMonitorsInputRequestTypeDef definition

class ListMonitorsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    MonitorStatus: NotRequired[str],

MonitorTypeDef#

# MonitorTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import MonitorTypeDef

def get_value() -> MonitorTypeDef:
    return {
        "MonitorName": ...,
        "MonitorArn": ...,
        "Status": ...,
    }
# MonitorTypeDef definition

class MonitorTypeDef(TypedDict):
    MonitorName: str,
    MonitorArn: str,
    Status: MonitorConfigStateType,  # (1)
    ProcessingStatus: NotRequired[MonitorProcessingStatusCodeType],  # (2)
  1. See MonitorConfigStateType
  2. See MonitorProcessingStatusCodeType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ListTagsForResourceInputRequestTypeDef

def get_value() -> ListTagsForResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
    }
# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ListTagsForResourceOutputTypeDef

def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }
# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    Tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

NetworkTypeDef#

# NetworkTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import NetworkTypeDef

def get_value() -> NetworkTypeDef:
    return {
        "ASName": ...,
        "ASNumber": ...,
    }
# NetworkTypeDef definition

class NetworkTypeDef(TypedDict):
    ASName: str,
    ASNumber: int,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import PaginatorConfigTypeDef

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

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

RoundTripTimeTypeDef#

# RoundTripTimeTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import RoundTripTimeTypeDef

def get_value() -> RoundTripTimeTypeDef:
    return {
        "P50": ...,
    }
# RoundTripTimeTypeDef definition

class RoundTripTimeTypeDef(TypedDict):
    P50: NotRequired[float],
    P90: NotRequired[float],
    P95: NotRequired[float],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import TagResourceInputRequestTypeDef

def get_value() -> TagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "Tags": ...,
    }
# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Mapping[str, str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import UntagResourceInputRequestTypeDef

def get_value() -> UntagResourceInputRequestTypeDef:
    return {
        "ResourceArn": ...,
        "TagKeys": ...,
    }
# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

UpdateMonitorOutputTypeDef#

# UpdateMonitorOutputTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import UpdateMonitorOutputTypeDef

def get_value() -> UpdateMonitorOutputTypeDef:
    return {
        "MonitorArn": ...,
        "Status": ...,
        "ResponseMetadata": ...,
    }
# UpdateMonitorOutputTypeDef definition

class UpdateMonitorOutputTypeDef(TypedDict):
    MonitorArn: str,
    Status: MonitorConfigStateType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MonitorConfigStateType
  2. See ResponseMetadataTypeDef

InternetMeasurementsLogDeliveryTypeDef#

# InternetMeasurementsLogDeliveryTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import InternetMeasurementsLogDeliveryTypeDef

def get_value() -> InternetMeasurementsLogDeliveryTypeDef:
    return {
        "S3Config": ...,
    }
# InternetMeasurementsLogDeliveryTypeDef definition

class InternetMeasurementsLogDeliveryTypeDef(TypedDict):
    S3Config: NotRequired[S3ConfigTypeDef],  # (1)
  1. See S3ConfigTypeDef

ListMonitorsOutputTypeDef#

# ListMonitorsOutputTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ListMonitorsOutputTypeDef

def get_value() -> ListMonitorsOutputTypeDef:
    return {
        "Monitors": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListMonitorsOutputTypeDef definition

class ListMonitorsOutputTypeDef(TypedDict):
    Monitors: List[MonitorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MonitorTypeDef
  2. See ResponseMetadataTypeDef

NetworkImpairmentTypeDef#

# NetworkImpairmentTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import NetworkImpairmentTypeDef

def get_value() -> NetworkImpairmentTypeDef:
    return {
        "Networks": ...,
        "AsPath": ...,
        "NetworkEventType": ...,
    }
# NetworkImpairmentTypeDef definition

class NetworkImpairmentTypeDef(TypedDict):
    Networks: List[NetworkTypeDef],  # (1)
    AsPath: List[NetworkTypeDef],  # (1)
    NetworkEventType: TriangulationEventTypeType,  # (3)
  1. See NetworkTypeDef
  2. See NetworkTypeDef
  3. See TriangulationEventTypeType

PerformanceMeasurementTypeDef#

# PerformanceMeasurementTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import PerformanceMeasurementTypeDef

def get_value() -> PerformanceMeasurementTypeDef:
    return {
        "ExperienceScore": ...,
    }
# PerformanceMeasurementTypeDef definition

class PerformanceMeasurementTypeDef(TypedDict):
    ExperienceScore: NotRequired[float],
    PercentOfTotalTrafficImpacted: NotRequired[float],
    PercentOfClientLocationImpacted: NotRequired[float],
    RoundTripTime: NotRequired[RoundTripTimeTypeDef],  # (1)
  1. See RoundTripTimeTypeDef

CreateMonitorInputRequestTypeDef#

# CreateMonitorInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import CreateMonitorInputRequestTypeDef

def get_value() -> CreateMonitorInputRequestTypeDef:
    return {
        "MonitorName": ...,
    }
# CreateMonitorInputRequestTypeDef definition

class CreateMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,
    Resources: NotRequired[Sequence[str]],
    ClientToken: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],
    MaxCityNetworksToMonitor: NotRequired[int],
    InternetMeasurementsLogDelivery: NotRequired[InternetMeasurementsLogDeliveryTypeDef],  # (1)
    TrafficPercentageToMonitor: NotRequired[int],
  1. See InternetMeasurementsLogDeliveryTypeDef

GetMonitorOutputTypeDef#

# GetMonitorOutputTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import GetMonitorOutputTypeDef

def get_value() -> GetMonitorOutputTypeDef:
    return {
        "MonitorName": ...,
        "MonitorArn": ...,
        "Resources": ...,
        "Status": ...,
        "CreatedAt": ...,
        "ModifiedAt": ...,
        "ProcessingStatus": ...,
        "ProcessingStatusInfo": ...,
        "Tags": ...,
        "MaxCityNetworksToMonitor": ...,
        "InternetMeasurementsLogDelivery": ...,
        "TrafficPercentageToMonitor": ...,
        "ResponseMetadata": ...,
    }
# GetMonitorOutputTypeDef definition

class GetMonitorOutputTypeDef(TypedDict):
    MonitorName: str,
    MonitorArn: str,
    Resources: List[str],
    Status: MonitorConfigStateType,  # (1)
    CreatedAt: datetime,
    ModifiedAt: datetime,
    ProcessingStatus: MonitorProcessingStatusCodeType,  # (2)
    ProcessingStatusInfo: str,
    Tags: Dict[str, str],
    MaxCityNetworksToMonitor: int,
    InternetMeasurementsLogDelivery: InternetMeasurementsLogDeliveryTypeDef,  # (3)
    TrafficPercentageToMonitor: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See MonitorConfigStateType
  2. See MonitorProcessingStatusCodeType
  3. See InternetMeasurementsLogDeliveryTypeDef
  4. See ResponseMetadataTypeDef

UpdateMonitorInputRequestTypeDef#

# UpdateMonitorInputRequestTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import UpdateMonitorInputRequestTypeDef

def get_value() -> UpdateMonitorInputRequestTypeDef:
    return {
        "MonitorName": ...,
    }
# UpdateMonitorInputRequestTypeDef definition

class UpdateMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,
    ResourcesToAdd: NotRequired[Sequence[str]],
    ResourcesToRemove: NotRequired[Sequence[str]],
    Status: NotRequired[MonitorConfigStateType],  # (1)
    ClientToken: NotRequired[str],
    MaxCityNetworksToMonitor: NotRequired[int],
    InternetMeasurementsLogDelivery: NotRequired[InternetMeasurementsLogDeliveryTypeDef],  # (2)
    TrafficPercentageToMonitor: NotRequired[int],
  1. See MonitorConfigStateType
  2. See InternetMeasurementsLogDeliveryTypeDef

InternetHealthTypeDef#

# InternetHealthTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import InternetHealthTypeDef

def get_value() -> InternetHealthTypeDef:
    return {
        "Availability": ...,
    }
# InternetHealthTypeDef definition

class InternetHealthTypeDef(TypedDict):
    Availability: NotRequired[AvailabilityMeasurementTypeDef],  # (1)
    Performance: NotRequired[PerformanceMeasurementTypeDef],  # (2)
  1. See AvailabilityMeasurementTypeDef
  2. See PerformanceMeasurementTypeDef

ImpactedLocationTypeDef#

# ImpactedLocationTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ImpactedLocationTypeDef

def get_value() -> ImpactedLocationTypeDef:
    return {
        "ASName": ...,
        "ASNumber": ...,
        "Country": ...,
        "Status": ...,
    }
# ImpactedLocationTypeDef definition

class ImpactedLocationTypeDef(TypedDict):
    ASName: str,
    ASNumber: int,
    Country: str,
    Status: HealthEventStatusType,  # (1)
    Subdivision: NotRequired[str],
    Metro: NotRequired[str],
    City: NotRequired[str],
    Latitude: NotRequired[float],
    Longitude: NotRequired[float],
    CountryCode: NotRequired[str],
    SubdivisionCode: NotRequired[str],
    ServiceLocation: NotRequired[str],
    CausedBy: NotRequired[NetworkImpairmentTypeDef],  # (2)
    InternetHealth: NotRequired[InternetHealthTypeDef],  # (3)
  1. See HealthEventStatusType
  2. See NetworkImpairmentTypeDef
  3. See InternetHealthTypeDef

GetHealthEventOutputTypeDef#

# GetHealthEventOutputTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import GetHealthEventOutputTypeDef

def get_value() -> GetHealthEventOutputTypeDef:
    return {
        "EventArn": ...,
        "EventId": ...,
        "StartedAt": ...,
        "EndedAt": ...,
        "CreatedAt": ...,
        "LastUpdatedAt": ...,
        "ImpactedLocations": ...,
        "Status": ...,
        "PercentOfTotalTrafficImpacted": ...,
        "ImpactType": ...,
        "ResponseMetadata": ...,
    }
# GetHealthEventOutputTypeDef definition

class GetHealthEventOutputTypeDef(TypedDict):
    EventArn: str,
    EventId: str,
    StartedAt: datetime,
    EndedAt: datetime,
    CreatedAt: datetime,
    LastUpdatedAt: datetime,
    ImpactedLocations: List[ImpactedLocationTypeDef],  # (1)
    Status: HealthEventStatusType,  # (2)
    PercentOfTotalTrafficImpacted: float,
    ImpactType: HealthEventImpactTypeType,  # (3)
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ImpactedLocationTypeDef
  2. See HealthEventStatusType
  3. See HealthEventImpactTypeType
  4. See ResponseMetadataTypeDef

HealthEventTypeDef#

# HealthEventTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import HealthEventTypeDef

def get_value() -> HealthEventTypeDef:
    return {
        "EventArn": ...,
        "EventId": ...,
        "StartedAt": ...,
        "LastUpdatedAt": ...,
        "ImpactedLocations": ...,
        "Status": ...,
        "ImpactType": ...,
    }
# HealthEventTypeDef definition

class HealthEventTypeDef(TypedDict):
    EventArn: str,
    EventId: str,
    StartedAt: datetime,
    LastUpdatedAt: datetime,
    ImpactedLocations: List[ImpactedLocationTypeDef],  # (1)
    Status: HealthEventStatusType,  # (2)
    ImpactType: HealthEventImpactTypeType,  # (3)
    EndedAt: NotRequired[datetime],
    CreatedAt: NotRequired[datetime],
    PercentOfTotalTrafficImpacted: NotRequired[float],
  1. See ImpactedLocationTypeDef
  2. See HealthEventStatusType
  3. See HealthEventImpactTypeType

ListHealthEventsOutputTypeDef#

# ListHealthEventsOutputTypeDef usage example

from mypy_boto3_internetmonitor.type_defs import ListHealthEventsOutputTypeDef

def get_value() -> ListHealthEventsOutputTypeDef:
    return {
        "HealthEvents": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }
# ListHealthEventsOutputTypeDef definition

class ListHealthEventsOutputTypeDef(TypedDict):
    HealthEvents: List[HealthEventTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HealthEventTypeDef
  2. See ResponseMetadataTypeDef