Skip to content

Type definitions#

Index > CloudWatchInternetMonitor > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AvailabilityMeasurementTypeDef#

# AvailabilityMeasurementTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeleteMonitorInputRequestTypeDef#

# DeleteMonitorInputRequestTypeDef definition

class DeleteMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,

FilterParameterTypeDef#

# FilterParameterTypeDef definition

class FilterParameterTypeDef(TypedDict):
    Field: NotRequired[str],
    Operator: NotRequired[OperatorType],  # (1)
    Values: NotRequired[Sequence[str]],
  1. See OperatorType

GetHealthEventInputRequestTypeDef#

# GetHealthEventInputRequestTypeDef definition

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

GetMonitorInputRequestTypeDef#

# GetMonitorInputRequestTypeDef definition

class GetMonitorInputRequestTypeDef(TypedDict):
    MonitorName: str,

GetQueryResultsInputRequestTypeDef#

# GetQueryResultsInputRequestTypeDef definition

class GetQueryResultsInputRequestTypeDef(TypedDict):
    MonitorName: str,
    QueryId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

QueryFieldTypeDef#

# QueryFieldTypeDef definition

class QueryFieldTypeDef(TypedDict):
    Name: NotRequired[str],
    Type: NotRequired[str],

GetQueryStatusInputRequestTypeDef#

# GetQueryStatusInputRequestTypeDef definition

class GetQueryStatusInputRequestTypeDef(TypedDict):
    MonitorName: str,
    QueryId: str,

LocalHealthEventsConfigTypeDef#

# LocalHealthEventsConfigTypeDef definition

class LocalHealthEventsConfigTypeDef(TypedDict):
    Status: NotRequired[LocalHealthEventsConfigStatusType],  # (1)
    HealthScoreThreshold: NotRequired[float],
    MinTrafficImpact: NotRequired[float],
  1. See LocalHealthEventsConfigStatusType

S3ConfigTypeDef#

# S3ConfigTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListMonitorsInputRequestTypeDef#

# ListMonitorsInputRequestTypeDef definition

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

MonitorTypeDef#

# MonitorTypeDef definition

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

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceArn: str,

NetworkTypeDef#

# NetworkTypeDef definition

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

RoundTripTimeTypeDef#

# RoundTripTimeTypeDef definition

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

StopQueryInputRequestTypeDef#

# StopQueryInputRequestTypeDef definition

class StopQueryInputRequestTypeDef(TypedDict):
    MonitorName: str,
    QueryId: str,

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

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

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

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

CreateMonitorOutputTypeDef#

# CreateMonitorOutputTypeDef definition

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

GetQueryStatusOutputTypeDef#

# GetQueryStatusOutputTypeDef definition

class GetQueryStatusOutputTypeDef(TypedDict):
    Status: QueryStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryStatusType
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

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

StartQueryOutputTypeDef#

# StartQueryOutputTypeDef definition

class StartQueryOutputTypeDef(TypedDict):
    QueryId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateMonitorOutputTypeDef#

# UpdateMonitorOutputTypeDef definition

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

GetQueryResultsOutputTypeDef#

# GetQueryResultsOutputTypeDef definition

class GetQueryResultsOutputTypeDef(TypedDict):
    Fields: List[QueryFieldTypeDef],  # (1)
    Data: List[List[str]],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See QueryFieldTypeDef
  2. See ResponseMetadataTypeDef

HealthEventsConfigTypeDef#

# HealthEventsConfigTypeDef definition

class HealthEventsConfigTypeDef(TypedDict):
    AvailabilityScoreThreshold: NotRequired[float],
    PerformanceScoreThreshold: NotRequired[float],
    AvailabilityLocalHealthEventsConfig: NotRequired[LocalHealthEventsConfigTypeDef],  # (1)
    PerformanceLocalHealthEventsConfig: NotRequired[LocalHealthEventsConfigTypeDef],  # (1)
  1. See LocalHealthEventsConfigTypeDef
  2. See LocalHealthEventsConfigTypeDef

InternetMeasurementsLogDeliveryTypeDef#

# InternetMeasurementsLogDeliveryTypeDef definition

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

ListMonitorsInputListMonitorsPaginateTypeDef#

# ListMonitorsInputListMonitorsPaginateTypeDef definition

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

ListHealthEventsInputListHealthEventsPaginateTypeDef#

# 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 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

StartQueryInputRequestTypeDef#

# StartQueryInputRequestTypeDef definition

class StartQueryInputRequestTypeDef(TypedDict):
    MonitorName: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    QueryType: QueryTypeType,  # (1)
    FilterParameters: NotRequired[Sequence[FilterParameterTypeDef]],  # (2)
  1. See QueryTypeType
  2. See FilterParameterTypeDef

ListMonitorsOutputTypeDef#

# ListMonitorsOutputTypeDef definition

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

NetworkImpairmentTypeDef#

# 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 definition

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

CreateMonitorInputRequestTypeDef#

# 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],
    HealthEventsConfig: NotRequired[HealthEventsConfigTypeDef],  # (2)
  1. See InternetMeasurementsLogDeliveryTypeDef
  2. See HealthEventsConfigTypeDef

GetMonitorOutputTypeDef#

# 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,
    HealthEventsConfig: HealthEventsConfigTypeDef,  # (4)
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See MonitorConfigStateType
  2. See MonitorProcessingStatusCodeType
  3. See InternetMeasurementsLogDeliveryTypeDef
  4. See HealthEventsConfigTypeDef
  5. See ResponseMetadataTypeDef

UpdateMonitorInputRequestTypeDef#

# 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],
    HealthEventsConfig: NotRequired[HealthEventsConfigTypeDef],  # (3)
  1. See MonitorConfigStateType
  2. See InternetMeasurementsLogDeliveryTypeDef
  3. See HealthEventsConfigTypeDef

InternetHealthTypeDef#

# InternetHealthTypeDef definition

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

ImpactedLocationTypeDef#

# 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)
    Ipv4Prefixes: NotRequired[List[str]],
  1. See HealthEventStatusType
  2. See NetworkImpairmentTypeDef
  3. See InternetHealthTypeDef

GetHealthEventOutputTypeDef#

# 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)
    HealthScoreThreshold: float,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ImpactedLocationTypeDef
  2. See HealthEventStatusType
  3. See HealthEventImpactTypeType
  4. See ResponseMetadataTypeDef

HealthEventTypeDef#

# 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],
    HealthScoreThreshold: NotRequired[float],
  1. See ImpactedLocationTypeDef
  2. See HealthEventStatusType
  3. See HealthEventImpactTypeType

ListHealthEventsOutputTypeDef#

# ListHealthEventsOutputTypeDef definition

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