Typed dictionaries

Index > CloudWatchInternetMonitor > Typed dictionaries

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

AvailabilityMeasurementTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import AvailabilityMeasurementTypeDef

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

Definition

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

CreateMonitorInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import CreateMonitorInputRequestTypeDef

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

Definition

class CreateMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,
    MaxCityNetworksToMonitor: int,
    Resources: NotRequired[Sequence[str]],
    ClientToken: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ResponseMetadataTypeDef

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

Definition

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

DeleteMonitorInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import DeleteMonitorInputRequestTypeDef

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

Definition

class DeleteMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,

GetHealthEventInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import GetHealthEventInputRequestTypeDef

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

Definition

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

GetMonitorInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import GetMonitorInputRequestTypeDef

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

Definition

class GetMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import PaginatorConfigTypeDef

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

Definition

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

ListHealthEventsInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ListHealthEventsInputRequestTypeDef

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

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

ListMonitorsInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ListMonitorsInputRequestTypeDef

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

Definition

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

MonitorTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import MonitorTypeDef

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

Definition

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

1. See MonitorConfigStateType
2. See MonitorProcessingStatusCodeType

ListTagsForResourceInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ListTagsForResourceInputRequestTypeDef

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

Definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

NetworkTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import NetworkTypeDef

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

Definition

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

RoundTripTimeTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import RoundTripTimeTypeDef

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

Definition

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

TagResourceInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import TagResourceInputRequestTypeDef

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

Definition

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

UntagResourceInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import UntagResourceInputRequestTypeDef

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

Definition

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

UpdateMonitorInputRequestTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import UpdateMonitorInputRequestTypeDef

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

Definition

class UpdateMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,
    ResourcesToAdd: NotRequired[Sequence[str]],
    ResourcesToRemove: NotRequired[Sequence[str]],
    Status: NotRequired[MonitorConfigStateType],  # (1)
    ClientToken: NotRequired[str],
    MaxCityNetworksToMonitor: NotRequired[int],

1. See MonitorConfigStateType

CreateMonitorOutputTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import CreateMonitorOutputTypeDef

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

Definition

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

1. See MonitorConfigStateType
2. See ResponseMetadataTypeDef

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": ...,
        "ResponseMetadata": ...,
    }

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,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See MonitorConfigStateType
2. See MonitorProcessingStatusCodeType
3. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ListTagsForResourceOutputTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

UpdateMonitorOutputTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import UpdateMonitorOutputTypeDef

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

Definition

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

1. See MonitorConfigStateType
2. See ResponseMetadataTypeDef

ListHealthEventsInputListHealthEventsPaginateTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ListHealthEventsInputListHealthEventsPaginateTypeDef

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

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

ListMonitorsInputListMonitorsPaginateTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ListMonitorsInputListMonitorsPaginateTypeDef

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

Definition

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

1. See PaginatorConfigTypeDef

ListMonitorsOutputTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ListMonitorsOutputTypeDef

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

Definition

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

1. See MonitorTypeDef
2. See ResponseMetadataTypeDef

NetworkImpairmentTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import NetworkImpairmentTypeDef

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

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

Usage Example

from mypy_boto3_internetmonitor.type_defs import PerformanceMeasurementTypeDef

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

Definition

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

1. See RoundTripTimeTypeDef

InternetHealthTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import InternetHealthTypeDef

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

Definition

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

1. See AvailabilityMeasurementTypeDef
2. See PerformanceMeasurementTypeDef

ImpactedLocationTypeDef

Usage Example

from mypy_boto3_internetmonitor.type_defs import ImpactedLocationTypeDef

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

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

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": ...,
    }

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

Usage Example

from mypy_boto3_internetmonitor.type_defs import HealthEventTypeDef

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

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

Usage Example

from mypy_boto3_internetmonitor.type_defs import ListHealthEventsOutputTypeDef

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

Definition

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

1. See HealthEventTypeDef
2. See ResponseMetadataTypeDef