Skip to content

GetProbeOutput

Source code in docs_src/capo_networkmonitor/types/get_probe_output.py
class GetProbeOutput(TypedDict, closed=True):
    probe_id: NotRequired["capo_networkmonitor.types.probe_id.ProbeId"]
    """<p>The ID of the probe for which details are returned.</p>"""
    probe_arn: NotRequired["capo_networkmonitor.types.arn.Arn"]
    """<p>The ARN of the probe.</p>"""
    source_arn: "capo_networkmonitor.types.arn.Arn"
    """<p>The ARN of the probe.</p>"""
    destination: "capo_networkmonitor.types.destination.Destination"
    """<p>The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.</p>"""
    destination_port: NotRequired["capo_networkmonitor.types.port.Port"]
    """<p>The port associated with the <code>destination</code>. This is required only if the <code>protocol</code> is <code>TCP</code> and must be a number between <code>1</code> and <code>65536</code>.</p>"""
    protocol: "capo_networkmonitor.types.protocol.Protocol"
    """<p>The protocol used for the network traffic between the <code>source</code> and <code>destination</code>. This must be either <code>TCP</code> or <code>ICMP</code>.</p>"""
    packet_size: NotRequired["capo_networkmonitor.types.packet_size.PacketSize"]
    """<p>The size of the packets sent between the source and destination. This must be a number between <code>56</code> and <code>8500</code>.</p>"""
    address_family: NotRequired[
        "capo_networkmonitor.types.address_family.AddressFamily"
    ]
    """<p>Indicates whether the IP address is <code>IPV4</code> or <code>IPV6</code>.</p>"""
    vpc_id: NotRequired["capo_networkmonitor.types.vpc_id.VpcId"]
    """<p>The ID of the source VPC or subnet.</p>"""
    state: NotRequired["capo_networkmonitor.types.probe_state.ProbeState"]
    """<p>The state of the probe.</p>"""
    created_at: NotRequired[
        "capo_networkmonitor.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The time and date that the probe was created.</p>"""
    modified_at: NotRequired[
        "capo_networkmonitor.types.iso8601_timestamp.Iso8601Timestamp"
    ]
    """<p>The time and date that the probe was last modified.</p>"""
    tags: NotRequired["capo_networkmonitor.types.tag_map.TagMap"]
    """<p>The list of key-value pairs assigned to the probe.</p>"""

address_family instance-attribute

address_family: NotRequired[AddressFamily]

Indicates whether the IP address is IPV4 or IPV6.

created_at instance-attribute

created_at: NotRequired[Iso8601Timestamp]

The time and date that the probe was created.

destination instance-attribute

destination: Destination

The destination IP address for the monitor. This must be either an IPv4 or IPv6 address.

destination_port instance-attribute

destination_port: NotRequired[Port]

The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536.

modified_at instance-attribute

modified_at: NotRequired[Iso8601Timestamp]

The time and date that the probe was last modified.

packet_size instance-attribute

packet_size: NotRequired[PacketSize]

The size of the packets sent between the source and destination. This must be a number between 56 and 8500.

probe_arn instance-attribute

probe_arn: NotRequired[Arn]

The ARN of the probe.

probe_id instance-attribute

probe_id: NotRequired[ProbeId]

The ID of the probe for which details are returned.

protocol instance-attribute

protocol: Protocol

The protocol used for the network traffic between the source and destination. This must be either TCP or ICMP.

source_arn instance-attribute

source_arn: Arn

The ARN of the probe.

state instance-attribute

state: NotRequired[ProbeState]

The state of the probe.

tags instance-attribute

tags: NotRequired[TagMap]

The list of key-value pairs assigned to the probe.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

The ID of the source VPC or subnet.