Skip to content

Type definitions#

Index > CloudWatchNetworkMonitor > Type definitions

Auto-generated documentation for CloudWatchNetworkMonitor type annotations stubs module mypy-boto3-networkmonitor.

CreateMonitorProbeInputTypeDef#

# CreateMonitorProbeInputTypeDef definition

class CreateMonitorProbeInputTypeDef(TypedDict):
    sourceArn: str,
    destination: str,
    protocol: ProtocolType,  # (1)
    destinationPort: NotRequired[int],
    packetSize: NotRequired[int],
    probeTags: NotRequired[Mapping[str, str]],
  1. See ProtocolType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

ProbeInputTypeDef#

# ProbeInputTypeDef definition

class ProbeInputTypeDef(TypedDict):
    sourceArn: str,
    destination: str,
    protocol: ProtocolType,  # (1)
    destinationPort: NotRequired[int],
    packetSize: NotRequired[int],
    tags: NotRequired[Mapping[str, str]],
  1. See ProtocolType

DeleteMonitorInputRequestTypeDef#

# DeleteMonitorInputRequestTypeDef definition

class DeleteMonitorInputRequestTypeDef(TypedDict):
    monitorName: str,

DeleteProbeInputRequestTypeDef#

# DeleteProbeInputRequestTypeDef definition

class DeleteProbeInputRequestTypeDef(TypedDict):
    monitorName: str,
    probeId: str,

GetMonitorInputRequestTypeDef#

# GetMonitorInputRequestTypeDef definition

class GetMonitorInputRequestTypeDef(TypedDict):
    monitorName: str,

ProbeTypeDef#

# ProbeTypeDef definition

class ProbeTypeDef(TypedDict):
    sourceArn: str,
    destination: str,
    protocol: ProtocolType,  # (1)
    probeId: NotRequired[str],
    probeArn: NotRequired[str],
    destinationPort: NotRequired[int],
    packetSize: NotRequired[int],
    addressFamily: NotRequired[AddressFamilyType],  # (2)
    vpcId: NotRequired[str],
    state: NotRequired[ProbeStateType],  # (3)
    createdAt: NotRequired[datetime],
    modifiedAt: NotRequired[datetime],
    tags: NotRequired[Dict[str, str]],
  1. See ProtocolType
  2. See AddressFamilyType
  3. See ProbeStateType

GetProbeInputRequestTypeDef#

# GetProbeInputRequestTypeDef definition

class GetProbeInputRequestTypeDef(TypedDict):
    monitorName: str,
    probeId: str,

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],
    state: NotRequired[str],

MonitorSummaryTypeDef#

# MonitorSummaryTypeDef definition

class MonitorSummaryTypeDef(TypedDict):
    monitorArn: str,
    monitorName: str,
    state: MonitorStateType,  # (1)
    aggregationPeriod: NotRequired[int],
    tags: NotRequired[Dict[str, str]],
  1. See MonitorStateType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateMonitorInputRequestTypeDef#

# UpdateMonitorInputRequestTypeDef definition

class UpdateMonitorInputRequestTypeDef(TypedDict):
    monitorName: str,
    aggregationPeriod: int,

UpdateProbeInputRequestTypeDef#

# UpdateProbeInputRequestTypeDef definition

class UpdateProbeInputRequestTypeDef(TypedDict):
    monitorName: str,
    probeId: str,
    state: NotRequired[ProbeStateType],  # (1)
    destination: NotRequired[str],
    destinationPort: NotRequired[int],
    protocol: NotRequired[ProtocolType],  # (2)
    packetSize: NotRequired[int],
  1. See ProbeStateType
  2. See ProtocolType

CreateMonitorInputRequestTypeDef#

# CreateMonitorInputRequestTypeDef definition

class CreateMonitorInputRequestTypeDef(TypedDict):
    monitorName: str,
    probes: NotRequired[Sequence[CreateMonitorProbeInputTypeDef]],  # (1)
    aggregationPeriod: NotRequired[int],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See CreateMonitorProbeInputTypeDef

CreateMonitorOutputTypeDef#

# CreateMonitorOutputTypeDef definition

class CreateMonitorOutputTypeDef(TypedDict):
    monitorArn: str,
    monitorName: str,
    state: MonitorStateType,  # (1)
    aggregationPeriod: int,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MonitorStateType
  2. See ResponseMetadataTypeDef

CreateProbeOutputTypeDef#

# CreateProbeOutputTypeDef definition

class CreateProbeOutputTypeDef(TypedDict):
    probeId: str,
    probeArn: str,
    sourceArn: str,
    destination: str,
    destinationPort: int,
    protocol: ProtocolType,  # (1)
    packetSize: int,
    addressFamily: AddressFamilyType,  # (2)
    vpcId: str,
    state: ProbeStateType,  # (3)
    createdAt: datetime,
    modifiedAt: datetime,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ProtocolType
  2. See AddressFamilyType
  3. See ProbeStateType
  4. See ResponseMetadataTypeDef

GetProbeOutputTypeDef#

# GetProbeOutputTypeDef definition

class GetProbeOutputTypeDef(TypedDict):
    probeId: str,
    probeArn: str,
    sourceArn: str,
    destination: str,
    destinationPort: int,
    protocol: ProtocolType,  # (1)
    packetSize: int,
    addressFamily: AddressFamilyType,  # (2)
    vpcId: str,
    state: ProbeStateType,  # (3)
    createdAt: datetime,
    modifiedAt: datetime,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ProtocolType
  2. See AddressFamilyType
  3. See ProbeStateType
  4. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

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

UpdateMonitorOutputTypeDef#

# UpdateMonitorOutputTypeDef definition

class UpdateMonitorOutputTypeDef(TypedDict):
    monitorArn: str,
    monitorName: str,
    state: MonitorStateType,  # (1)
    aggregationPeriod: int,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MonitorStateType
  2. See ResponseMetadataTypeDef

UpdateProbeOutputTypeDef#

# UpdateProbeOutputTypeDef definition

class UpdateProbeOutputTypeDef(TypedDict):
    probeId: str,
    probeArn: str,
    sourceArn: str,
    destination: str,
    destinationPort: int,
    protocol: ProtocolType,  # (1)
    packetSize: int,
    addressFamily: AddressFamilyType,  # (2)
    vpcId: str,
    state: ProbeStateType,  # (3)
    createdAt: datetime,
    modifiedAt: datetime,
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See ProtocolType
  2. See AddressFamilyType
  3. See ProbeStateType
  4. See ResponseMetadataTypeDef

CreateProbeInputRequestTypeDef#

# CreateProbeInputRequestTypeDef definition

class CreateProbeInputRequestTypeDef(TypedDict):
    monitorName: str,
    probe: ProbeInputTypeDef,  # (1)
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See ProbeInputTypeDef

GetMonitorOutputTypeDef#

# GetMonitorOutputTypeDef definition

class GetMonitorOutputTypeDef(TypedDict):
    monitorArn: str,
    monitorName: str,
    state: MonitorStateType,  # (1)
    aggregationPeriod: int,
    tags: Dict[str, str],
    probes: List[ProbeTypeDef],  # (2)
    createdAt: datetime,
    modifiedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MonitorStateType
  2. See ProbeTypeDef
  3. See ResponseMetadataTypeDef

ListMonitorsInputListMonitorsPaginateTypeDef#

# ListMonitorsInputListMonitorsPaginateTypeDef definition

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

ListMonitorsOutputTypeDef#

# ListMonitorsOutputTypeDef definition

class ListMonitorsOutputTypeDef(TypedDict):
    monitors: List[MonitorSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MonitorSummaryTypeDef
  2. See ResponseMetadataTypeDef