ManagedintegrationsforIoTDeviceManagement / Client / start_device_discovery

start_device_discovery

ManagedintegrationsforIoTDeviceManagement.Client.start_device_discovery(**kwargs)

This API is used to start device discovery for hub-connected and third-party-connected devices. The authentication material (install code) is passed as a message to the controller telling it to start the discovery.

See also: AWS API Documentation

Request Syntax

response = client.start_device_discovery(
    DiscoveryType='ZWAVE'|'ZIGBEE'|'CLOUD'|'CUSTOM',
    CustomProtocolDetail={
        'string': 'string'
    },
    ControllerIdentifier='string',
    ConnectorAssociationIdentifier='string',
    AccountAssociationId='string',
    AuthenticationMaterial='string',
    AuthenticationMaterialType='ZWAVE_INSTALL_CODE',
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters:

  • DiscoveryType (string) –

    [REQUIRED]

    The discovery type supporting the type of device to be discovered in the device discovery task request.

  • CustomProtocolDetail (dict) –

    Additional protocol-specific details required for device discovery, which vary based on the discovery type.

    Note

    For a DiscoveryType of CUSTOM, the string-to-string map must have a key value of Name set to a non-empty-string.

    • (string) –

      • (string) –

  • ControllerIdentifier (string) – The id of the end-user’s IoT hub.

  • ConnectorAssociationIdentifier (string) – The id of the connector association.

  • AccountAssociationId (string) – The identifier of the cloud-to-cloud account association to use for discovery of third-party devices.

  • AuthenticationMaterial (string) – The authentication material required to start the local device discovery job request.

  • AuthenticationMaterialType (string) – The type of authentication material used for device discovery jobs.

  • ClientToken (string) – 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.

  • Tags (dict) –

    A set of key/value pairs that are used to manage the device discovery request.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'StartedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • Id (string) –

      The id of the device discovery job request.

    • StartedAt (datetime) –

      The timestamp value for the start time of the device discovery.

Exceptions