StartDeviceDiscoveryRequest ¶

class StartDeviceDiscoveryRequest(TypedDict, closed=True):
    discovery_type: "capo_iot_managed_integrations.types.discovery_type.DiscoveryType"
    """<p>The discovery type supporting the type of device to be discovered in the device discovery task request.</p>"""
    custom_protocol_detail: NotRequired[
        "capo_iot_managed_integrations.types.custom_protocol_detail.CustomProtocolDetail"
    ]
    """<p>Additional protocol-specific details required for device discovery, which vary based on the discovery type.</p> <note> <p>For a <code>DiscoveryType</code> of <code>CUSTOM</code>, the string-to-string map must have a key value of <code>Name</code> set to a non-empty-string.</p> </note>"""
    controller_identifier: NotRequired[
        "capo_iot_managed_integrations.types.managed_thing_id.ManagedThingId"
    ]
    """<p>The id of the end-user's IoT hub.</p>"""
    connector_association_identifier: NotRequired[
        "capo_iot_managed_integrations.types.connector_association_id.ConnectorAssociationId"
    ]
    """<p>The id of the connector association.</p>"""
    account_association_id: NotRequired[
        "capo_iot_managed_integrations.types.account_association_id.AccountAssociationId"
    ]
    """<p>The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.</p>"""
    authentication_material: NotRequired[
        "capo_iot_managed_integrations.types.discovery_auth_material_string.DiscoveryAuthMaterialString"
    ]
    """<p>The authentication material required to start the local device discovery job request.</p>"""
    authentication_material_type: NotRequired[
        "capo_iot_managed_integrations.types.discovery_auth_material_type.DiscoveryAuthMaterialType"
    ]
    """<p>The type of authentication material used for device discovery jobs.</p>"""
    client_token: NotRequired[
        "capo_iot_managed_integrations.types.client_token.ClientToken"
    ]
    """<p>An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.</p>"""
    tags: NotRequired["capo_iot_managed_integrations.types.tags_map.TagsMap"]
    """<p>A set of key/value pairs that are used to manage the device discovery request.</p>"""
    connector_device_id_list: NotRequired[
        "capo_iot_managed_integrations.types.connector_device_id_list.ConnectorDeviceIdList"
    ]
    """<p>Used as a filter for PLA discoveries.</p>"""
    protocol: NotRequired[
        "capo_iot_managed_integrations.types.protocol_type.ProtocolType"
    ]
    """<p>The protocol type for capability rediscovery (ZWAVE, ZIGBEE, or CUSTOM).</p> <note> <p>This parameter is only available when the discovery type is CONTROLLER_CAPABILITY_REDISCOVERY.</p> </note>"""
    end_device_identifier: NotRequired[
        "capo_iot_managed_integrations.types.managed_thing_id.ManagedThingId"
    ]
    """<p>The unique id of the end device for capability rediscovery.</p> <note> <p>This parameter is only available when the discovery type is CONTROLLER_CAPABILITY_REDISCOVERY.</p> </note>"""